Struct ReactComponentName 

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

Validated React component name metadata.

Implementations

impl ReactComponentName

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

Creates a PascalCase ASCII React component name.

Errors

Returns ReactNameError when input is not an ASCII identifier or is not PascalCase-shaped.

Examples found in repository

examples/basic_usage.rs (line 7)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let target: EcmaScriptTarget = "es2024".parse()?;
    let identifier = JsIdentifier::new("createApp")?;
    let package = PackageName::new("@rustuse/example")?;
    let component = ReactComponentName::new("AppShell")?;

    assert_eq!(target.to_string(), "ES2024");
    assert_eq!(identifier.as_str(), "createApp");
    assert!(package.is_scoped());
    assert_eq!(component.as_str(), "AppShell");
    Ok(())
}

pub fn as_str(&self) -> &str

Returns the component name.

Examples found in repository

examples/basic_usage.rs (line 12)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let target: EcmaScriptTarget = "es2024".parse()?;
    let identifier = JsIdentifier::new("createApp")?;
    let package = PackageName::new("@rustuse/example")?;
    let component = ReactComponentName::new("AppShell")?;

    assert_eq!(target.to_string(), "ES2024");
    assert_eq!(identifier.as_str(), "createApp");
    assert!(package.is_scoped());
    assert_eq!(component.as_str(), "AppShell");
    Ok(())
}

Trait Implementations

impl Clone for ReactComponentName

fn clone(&self) -> ReactComponentName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReactComponentName

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

Formats the value using the given formatter.

impl Display for ReactComponentName

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

Formats the value using the given formatter.

impl FromStr for ReactComponentName

type Err = ReactNameError

The associated error which can be returned from parsing.

fn from_str( input: &str, ) -> Result<ReactComponentName, <ReactComponentName as FromStr>::Err>

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

impl Hash for ReactComponentName

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 ReactComponentName

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

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

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

impl StructuralPartialEq for ReactComponentName