Struct Name 

pub struct Name {
    pub components: Vec<NameComponent>,
}

A hierarchical NDN name: an ordered sequence of NameComponents.

Names identify both Interests and the Data that satisfies them, and are usually written and read as a ndn:/a/b/c-style URI – see Name::from_str and Name::to_uri. Name implements Ord so names can be sorted and compared, by comparing their encoded bytes.

Fields

components: Vec<NameComponent>

The name’s components, in order from least to most specific.

Implementations

impl Name

pub const fn empty() -> Self

The name with no components, i.e. ndn:/.

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

Parses a name from its URI form, e.g. /hello/world or ndn:/hello/world. The leading ndn: scheme is optional.

pub fn to_uri(&self) -> Url

Renders the name back into its ndn:/a/b/c URI form.

pub fn iter(&self) -> impl Iterator<Item = &NameComponent>

Iterates over the name’s components.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut NameComponent>

Iterates mutably over the name’s components.

pub fn into_iter(self) -> impl Iterator<Item = NameComponent>

Consumes the name, iterating over its components by value.

pub fn join<T: TryInto<Self>>(&self, other: T) -> Self

where <T as TryInto<Self>>::Error: Debug,

Appends other’s components to this name’s, returning the combined name. other can be another Name, a URI &str, or anything else that converts to a Name.

Panics

Panics if other fails to convert into a Name, e.g. an invalid URI string.

pub fn has_prefix(&self, prefix: &Name) -> bool

Returns whether prefix is a prefix of this name, component by component.

pub fn remove_prefix(&mut self, prefix: &Name) -> bool

Removes prefix from the front of this name if it’s actually a prefix, returning whether anything was removed.

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate 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 Display for Name

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

Formats the value using the given formatter.

impl Eq for Name

impl Extend<NameComponent> for Name

fn extend<T: IntoIterator<Item = NameComponent>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl From<NameComponent> for Name

fn from(value: NameComponent) -> Self

Converts to this type from the input type.

impl FromIterator<NameComponent> for Name

fn from_iter<T: IntoIterator<Item = NameComponent>>(iter: T) -> Self

Creates a value from an iterator.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Name

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.

impl PartialEq for Name

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Name

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 StructuralPartialEq for Name

impl Tlv for Name

const TYP: usize = 7usize

The assigned type number for this TLV record

fn inner_size(&self) -> usize

The size of the payload contained within this TLV

fn critical() -> bool

Whether the TLV is critical, see tlv_critical

fn from_reader(reader: impl Read) -> Result<Self, TlvError>

where Self: TlvDecode,

Read a TLV from a type implementing Read

impl TlvDecode for Name

fn decode(bytes: &mut Bytes) -> Result<Self>

Decode the value from a bytes::Buf

impl TlvEncode for Name

fn encode(&self) -> Bytes

Encode the value as a TLV record or part of one

fn size(&self) -> usize

The size of the encoded data in bytes

impl TryFrom<&str> for Name

type Error = NdnError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Name, NdnError>

Performs the conversion.