Struct Name 

pub struct Name { /* private fields */ }

An NDN name: an ordered sequence of name components.

Components are stored in a SmallVec with inline capacity for 8 elements, covering typical 4–8 component names without heap allocation.

Ordering follows the NDN Packet Format v0.3 §2.1 canonical order, component by component using NameComponent’s Ord impl.

Implementations

impl Name

pub fn root() -> Self

The root (empty) name /.

pub fn from_components( components: impl IntoIterator<Item = NameComponent>, ) -> Self

pub fn components(&self) -> &[NameComponent]

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

Returns true if prefix is a prefix of (or equal to) this name.

pub fn decode(value: Bytes) -> Result<Self, PacketError>

Decode a Name TLV from reader. The reader must be positioned at the start of the Name value (after the outer type+length have been consumed).

pub fn append(self, value: impl AsRef<[u8]>) -> Self

Append a generic component from raw bytes.

pub fn append_component(self, comp: NameComponent) -> Self

Append an already-constructed component.

pub fn append_segment(self, seg: u64) -> Self

Append a segment number component (type 0x32, big-endian encoding with leading zeros stripped per NDN naming conventions).

pub fn append_version(self, v: u64) -> Self

Append a Version component (type 0x36).

pub fn append_timestamp(self, ts: u64) -> Self

Append a Timestamp component (type 0x38).

pub fn append_sequence_num(self, seq: u64) -> Self

Append a SequenceNum component (type 0x3A).

pub fn append_byte_offset(self, off: u64) -> Self

Append a ByteOffset component (type 0x34).

pub fn append_blake3_digest(self, hash: [u8; 32]) -> Self

Append a BLAKE3 digest component (type 0x03, 32 bytes).

Experimental / NDA extension. See NameComponent::blake3_digest.

pub fn zone_root_from_hash(hash: [u8; 32]) -> Self

Build a single-component zone-root name from a pre-computed 32-byte hash.

The hash should be the BLAKE3 digest of a public key (or any 32-byte identifier). This is the low-level constructor; use ndn_security::ZoneKey::zone_root_name() for the full API that computes the hash from a public key.

Experimental / NDA extension — BLAKE3 component type (0x03) is not yet in the NDN Packet Format specification.

pub fn is_zone_root(&self) -> bool

Returns true if this name is a single BLAKE3-digest component (a zone root).

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 From<&str> for Name

Allow &str and String to convert into Name for builder ergonomics.

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Name

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for Name

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

Parse an NDN URI string into a Name.

Handles percent-decoding to roundtrip with Display.

let name: Name = "/edu/ucla/data".parse().unwrap();
assert_eq!(name.to_string(), "/edu/ucla/data");

type Err = PacketError

The associated error which can be returned from parsing.

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

NDN canonical name ordering (NDN Packet Format v0.3 §2.1).

Names are compared component by component from left to right. If all shared components are equal, the shorter name is smaller (prefix ordering).

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

impl StructuralPartialEq for Name