Struct ReactHookName 

pub struct ReactHookName(/* private fields */);

Validated React hook name metadata.

Implementations

impl ReactHookName

pub fn new(input: &str) -> Result<ReactHookName, ReactNameError>

Creates a lightly validated React hook name.

Errors

Returns ReactNameError when input is not an ASCII identifier or does not start with use plus a suffix.

pub fn as_str(&self) -> &str

Returns the hook name.

pub fn has_canonical_suffix(&self) -> bool

Returns whether the hook uses the common use + uppercase convention.

Trait Implementations

impl Clone for ReactHookName

fn clone(&self) -> ReactHookName

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReactHookName

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for ReactHookName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ReactHookName

fn cmp(&self, other: &ReactHookName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ReactHookName

fn eq(&self, other: &ReactHookName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ReactHookName

fn partial_cmp(&self, other: &ReactHookName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ReactHookName

impl StructuralPartialEq for ReactHookName