Struct cm_types::BoundedName

pub struct BoundedName<const N: usize>(_);

A BoundedName is a Name that can have a max length of N bytes.

Implementations

impl<const N: usize> BoundedName<N>

pub fn try_new(name: impl AsRef<str> + Into<String>) -> Result<Self, ParseError>

Creates a BoundedName from a String, returning an Err if the string fails validation. The string must be non-empty, no more than N characters in length, and consist of one or more of the following characters: a-z, 0-9, _, ., -.

pub fn validate(name: &str) -> Result<(), ParseError>

pub fn as_str(&self) -> &str

pub fn is_empty(&self) -> bool

Trait Implementations

impl<const N: usize> Clone for BoundedName<N>

fn clone(&self) -> BoundedName<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for BoundedName<N>

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

Formats the value using the given formatter.

impl<'de, const N: usize> Deserialize<'de> for BoundedName<N>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Display for BoundedName<N>

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

Formats the value using the given formatter.

impl<const N: usize> From<BoundedName<N>> for String

fn from(name: BoundedName<N>) -> String

Converts to this type from the input type.

impl<const N: usize> FromStr for BoundedName<N>

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl<const N: usize> Hash for BoundedName<N>

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<const N: usize> Ord for BoundedName<N>

fn cmp(&self, other: &BoundedName<N>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<const N: usize> PartialEq<&str> for BoundedName<N>

fn eq(&self, o: &&str) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialEq<BoundedName<N>> for BoundedName<N>

fn eq(&self, other: &BoundedName<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialEq<String> for BoundedName<N>

fn eq(&self, o: &String) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialOrd<BoundedName<N>> for BoundedName<N>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<const N: usize> Serialize for BoundedName<N>

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

Serialize this value into the given Serde serializer.

impl<const N: usize> Eq for BoundedName<N>

impl<const N: usize> StructuralEq for BoundedName<N>

impl<const N: usize> StructuralPartialEq for BoundedName<N>