Struct ComponentName 

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

A key under one of the Components maps.

The specification restricts these to ^[a-zA-Z0-9.\-_]+$, which is narrower than most Rust type names allow — Vec<User> cannot be a component name, so generic types have to be mangled into one.

Implementations

impl ComponentName

pub fn new(name: impl Into<String>) -> Result<Self, InvalidComponentName>

Validates and wraps a component name.

Errors

Returns InvalidComponentName when name is empty or contains a character outside A-Z a-z 0-9 . - _.

pub fn is_valid_char(c: char) -> bool

Whether c may appear in a component name.

pub fn is_valid(name: &str) -> bool

Whether name is a legal component name.

pub fn sanitized(name: &str) -> Result<Self, InvalidComponentName>

Rewrites name into a legal component name.

Illegal characters are replaced with _, and runs of them collapse. This is how a generic Rust type name becomes a component key.

Errors

Returns InvalidComponentName when nothing legal survives, which happens only for an empty input.

pub fn as_str(&self) -> &str

The name as a string slice.

Trait Implementations

impl Clone for ComponentName

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComponentName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ComponentName

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

Formats the value using the given formatter.

impl Eq for ComponentName

impl From<ComponentName> for String

fn from(name: ComponentName) -> Self

Converts to this type from the input type.

impl Hash for ComponentName

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 ComponentName

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ComponentName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ComponentName

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ComponentName

impl TryFrom<String> for ComponentName

type Error = InvalidComponentName

The type returned in the event of a conversion error.

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

Performs the conversion.