Struct tydi::Name

pub struct Name(_);

Type-safe wrapper for valid names.

The following rules apply for valid names

• The name is non-empty
• The name consists of letter, number and underscores
• The name does not start or end with an underscore
• The name does not start with a digit
• The name does not contain double underscores

Examples

Methods

impl Name

pub fn try_new(name: impl Into<String>) -> Result<Self>

Constructs a new name wrapper. Returns an error when the provided name is invalid.

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Deref for Name

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl Display for Name

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

Formats the value using the given formatter.

impl Eq for Name

impl<'_> From<&'_ Name> for String

fn from(name: &Name) -> Self

Performs the conversion.

impl From<Name> for String

fn from(name: Name) -> Self

Performs the conversion.

impl From<Name> for PathName

fn from(name: Name) -> Self

Performs the conversion.

impl FromIterator<Name> for PathName

fn from_iter<I: IntoIterator<Item = Name>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for Name

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Name

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Name

fn cmp(&self, other: &Name) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Name> for Name

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

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

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

This method tests for !=.

impl PartialEq<String> for Name

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<str> for Name

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Name> for Name

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Name

impl StructuralPartialEq for Name

impl<'_> TryFrom<&'_ str> for Name

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Name

type Error = Error

The type returned in the event of a conversion error.

fn try_from(string: String) -> Result<Self>

Performs the conversion.