Struct PreactHookName 

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

Validated Preact hook name metadata.

Implementations

impl PreactHookName

pub fn new(input: &str) -> Result<Self, PreactNameError>

Creates a lightly validated Preact hook name.

Errors

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

Examples found in repository

examples/basic_usage.rs (line 5)

fn main() -> Result<(), use_preact::PreactNameError> {
    let component = PreactComponentName::new("AppShell")?;
    let hook = PreactHookName::new("useSignal")?;

    assert_eq!(component.as_str(), "AppShell");
    assert_eq!(hook.as_str(), "useSignal");
    assert_eq!(PreactJsxRuntime::Automatic.as_str(), "automatic");
    Ok(())
}

pub fn as_str(&self) -> &str

Returns the hook name.

Examples found in repository

examples/basic_usage.rs (line 8)

fn main() -> Result<(), use_preact::PreactNameError> {
    let component = PreactComponentName::new("AppShell")?;
    let hook = PreactHookName::new("useSignal")?;

    assert_eq!(component.as_str(), "AppShell");
    assert_eq!(hook.as_str(), "useSignal");
    assert_eq!(PreactJsxRuntime::Automatic.as_str(), "automatic");
    Ok(())
}

pub fn has_canonical_suffix(&self) -> bool

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

Trait Implementations

impl Clone for PreactHookName

fn clone(&self) -> PreactHookName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreactHookName

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

Formats the value using the given formatter.

impl Display for PreactHookName

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

Formats the value using the given formatter.

impl FromStr for PreactHookName

type Err = PreactNameError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for PreactHookName

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

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 PreactHookName

fn cmp(&self, other: &PreactHookName) -> 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 PreactHookName

fn eq(&self, other: &PreactHookName) -> 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 PreactHookName

fn partial_cmp(&self, other: &PreactHookName) -> 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 TryFrom<&str> for PreactHookName

type Error = PreactNameError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for PreactHookName

impl StructuralPartialEq for PreactHookName