Struct tydi::PathName

pub struct PathName(_);

Type-safe path for names.

Allows wrapping a set of valid names in a hierarchy.

Methods

impl PathName

pub fn new(names: impl Iterator<Item = Name>) -> Self

pub fn try_new(
    names: impl IntoIterator<Item = impl TryInto<Name, Error = Error>>
) -> Result<Self>

pub fn is_empty(&self) -> bool

Returns true if this PathName is empty (∅).

pub fn push(&mut self, name: impl Into<Name>)

pub fn len(&self) -> usize

pub fn last(&self) -> Option<&Name>

pub fn parent(&self) -> Option<PathName>

Trait Implementations

impl Clone for PathName

fn clone(&self) -> PathName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathName

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

Formats the value using the given formatter.

impl Display for PathName

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

Formats the value using the given formatter.

impl Eq for PathName

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 Hash for PathName

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<'a> IntoIterator for &'a PathName

type Item = &'a Name

The type of the elements being iterated over.

type IntoIter = Iter<'a, Name>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for PathName

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

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

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

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

This method tests for !=.

impl PartialOrd<PathName> for PathName

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for PathName

impl StructuralPartialEq for PathName

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

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 PathName

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.