Struct PackageName 

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

Validated package name metadata.

Implementations

impl PackageName

pub fn new(input: &str) -> Result<PackageName, PackageJsonTextError>

Creates lightly validated package name metadata.

Errors

Returns PackageJsonTextError when input is empty, contains whitespace, or has an invalid scoped shape.

Examples found in repository

examples/basic_usage.rs (line 6)

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 package name.

pub fn is_scoped(&self) -> bool

Returns whether this package name is scoped.

Examples found in repository

examples/basic_usage.rs (line 11)

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 PackageName

fn clone(&self) -> PackageName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageName

fn deserialize<__D>( __deserializer: __D, ) -> Result<PackageName, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PackageName

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

Formats the value using the given formatter.

impl FromStr for PackageName

type Err = PackageJsonTextError

The associated error which can be returned from parsing.

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

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

impl Hash for PackageName

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 PackageName

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

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

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for PackageName

type Error = PackageJsonTextError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<PackageName, <PackageName as TryFrom<&str>>::Error>

Performs the conversion.

impl Eq for PackageName

impl StructuralPartialEq for PackageName