Struct nmt_rs::NamespaceId

pub struct NamespaceId<const NS_ID_SIZE: usize>(pub [u8; NS_ID_SIZE]);

A namespace identifier

Tuple Fields

0: [u8; NS_ID_SIZE]

Implementations

impl<const NS_ID_SIZE: usize> NamespaceId<NS_ID_SIZE>

pub const MAX_ID: NamespaceId<NS_ID_SIZE> = _

The maximum possible namespace id

pub const MAX_RESERVED_ID_ON_CELESTIA: NamespaceId<NS_ID_SIZE> = _

In celestia, 256 namespaces are reserved for “system” data. This is the maximum reserved namespace.

pub const fn max_id() -> Self

Returns maximum possible namespace id

pub fn is_reserved_on_celestia(&self) -> bool

Indicates whether the namespace is reserved for system data on Celestia.

Trait Implementations

impl<const NS_ID_SIZE: usize> AsRef<[u8]> for NamespaceId<NS_ID_SIZE>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<const NS_ID_SIZE: usize> Clone for NamespaceId<NS_ID_SIZE>

fn clone(&self) -> NamespaceId<NS_ID_SIZE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const NS_ID_SIZE: usize> Debug for NamespaceId<NS_ID_SIZE>

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

Formats the value using the given formatter.

impl<const NS_ID_SIZE: usize> Default for NamespaceId<NS_ID_SIZE>

fn default() -> Self

Returns the “default value” for a type.

impl<const NS_ID_SIZE: usize> Hash for NamespaceId<NS_ID_SIZE>

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 NS_ID_SIZE: usize> Ord for NamespaceId<NS_ID_SIZE>

fn cmp(&self, other: &NamespaceId<NS_ID_SIZE>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<const NS_ID_SIZE: usize> PartialEq for NamespaceId<NS_ID_SIZE>

fn eq(&self, other: &NamespaceId<NS_ID_SIZE>) -> 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<const NS_ID_SIZE: usize> PartialOrd for NamespaceId<NS_ID_SIZE>

fn partial_cmp(&self, other: &NamespaceId<NS_ID_SIZE>) -> 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<const NS_ID_SIZE: usize> TryFrom<&[u8]> for NamespaceId<NS_ID_SIZE>

type Error = InvalidNamespace

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<const NS_ID_SIZE: usize> Copy for NamespaceId<NS_ID_SIZE>

impl<const NS_ID_SIZE: usize> Eq for NamespaceId<NS_ID_SIZE>

impl<const NS_ID_SIZE: usize> StructuralPartialEq for NamespaceId<NS_ID_SIZE>