Struct nmt_rs::NamespacedHash

pub struct NamespacedHash<const NS_ID_SIZE: usize> { /* private fields */ }

A hash of some data, together with a namespace range

Implementations

impl<const NS_ID_SIZE: usize> NamespacedHash<NS_ID_SIZE>

pub const fn size() -> usize

Returns the size of the hash in bytes

pub const fn new( min_ns: NamespaceId<NS_ID_SIZE>, max_ns: NamespaceId<NS_ID_SIZE>, hash: [u8; 32], ) -> Self

Construct a new namespaced hash from the provided components

pub fn with_min_and_max_ns( min_ns: NamespaceId<NS_ID_SIZE>, max_ns: NamespaceId<NS_ID_SIZE>, ) -> Self

Construct a namespaced hash with the provided namespace range and the zero hash

pub fn min_namespace(&self) -> NamespaceId<NS_ID_SIZE>

Returns the min namespace id of the hash

pub fn max_namespace(&self) -> NamespaceId<NS_ID_SIZE>

Returns the max namespace id of the hash

pub fn hash(&self) -> [u8; 32]

Returns the hash without the namespace range

pub fn contains<M: NamespaceMerkleHasher<NS_ID_SIZE, Output = Self>>( &self, namespace: NamespaceId<NS_ID_SIZE>, ) -> bool

Check if the given hash includes the provided namespace under the given hasher

pub fn is_empty_root<M: NamespaceMerkleHasher<NS_ID_SIZE, Output = Self>>( &self, ) -> bool

Check if the hash is the empty root under the given hasher

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

Returns an iterator of the bytes of the namespaced hash

Trait Implementations

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

fn clone(&self) -> NamespacedHash<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 NamespacedHash<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 NamespacedHash<NS_ID_SIZE>

fn default() -> Self

Returns the “default value” for a type.

impl<const NS_ID_SIZE: usize> Hash for NamespacedHash<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 NamespacedHash<NS_ID_SIZE>

fn cmp(&self, other: &NamespacedHash<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 NamespacedHash<NS_ID_SIZE>

fn eq(&self, other: &NamespacedHash<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 NamespacedHash<NS_ID_SIZE>

fn partial_cmp(&self, other: &NamespacedHash<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 NamespacedHash<NS_ID_SIZE>

type Error = InvalidNamespacedHash

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> Eq for NamespacedHash<NS_ID_SIZE>

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