Struct Digest 

pub struct Digest(/* private fields */);

A 32-byte Blake2b256 hash output.

BCS

A Digest’s BCS serialized form is defined by the following:

digest = %d32 32OCTET

Due to historical reasons, even though a Digest has a fixed-length of 32, IOTA’s binary representation of a Digest is prefixed with its length meaning its serialized binary form (in bcs) is 33 bytes long vs a more compact 32 bytes.

Implementations

impl Digest

pub const LENGTH: usize = 32

A constant representing the length of a digest in bytes.

pub const ZERO: Digest

A constant representing a zero digest.

pub const MIN: Digest

The lexicographically minimum digest

pub const MAX: Digest

The lexicographically maximum digest

pub const OBJECT_DELETED: Digest

A marker that signifies the object is deleted.

pub const OBJECT_WRAPPED: Digest

A marker that signifies the object is wrapped into another object.

pub const OBJECT_CANCELLED: Digest

A marker that signifies the object is cancelled.

pub const GENESIS_MARKER: Digest = Self::ZERO

A digest used to signify the parent transaction was the genesis. Note that this is not the same as the digest of the genesis transaction, which cannot be known ahead of time.

pub const fn new(digest: [u8; 32]) -> Digest

Generates a new digest from the provided 32 byte array containing u8 values.

pub fn generate<R>(rng: R) -> Digest

where R: RngCore + CryptoRng,

Generates a new digest from the provided random number generator.

pub fn random() -> Digest

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

Returns a slice to the inner array representation of this digest.

pub const fn into_inner(self) -> [u8; 32]

Returns the inner array representation of this digest.

pub const fn as_bytes(&self) -> &[u8]

Returns a slice of bytes representing the digest.

pub fn from_base58<T>(base58: T) -> Result<Digest, DigestParseError>

where T: AsRef<[u8]>,

Decodes a digest from a Base58 encoded string.

pub fn to_base58(&self) -> String

Returns a Base58 encoded string representation of this digest.

pub fn from_bytes<T>(bytes: T) -> Result<Digest, DigestParseError>

where T: AsRef<[u8]>,

Generates a digest from bytes.

pub const fn next_lexicographical(&self) -> Digest

Returns the next digest in byte-increasing order.

pub const fn next_lexicographical_opt(&self) -> Option<Digest>

Returns the next digest in byte-increasing order, or None if the result would overflow.

pub fn is_object_alive(&self) -> bool

Returns whether the digest represents an object that is neither deleted nor wrapped

pub fn is_object_deleted(&self) -> bool

Returns whether the digest represents a deleted object

pub fn is_object_wrapped(&self) -> bool

Returns whether the digest represents an object wrapped in another object.

Trait Implementations

impl Arbitrary for Digest

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Digest>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( args_shared: <Digest as Arbitrary>::Parameters, ) -> <Digest as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl AsRef<[u8]> for Digest

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

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

impl AsRef<[u8; 32]> for Digest

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

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

impl Clone for Digest

fn clone(&self) -> Digest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Digest

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

Formats the value using the given formatter.

impl Default for Digest

fn default() -> Digest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Digest

fn deserialize<__D>( __deserializer: __D, ) -> Result<Digest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Digest

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

Formats the value using the given formatter.

impl From<[u8; 32]> for Digest

fn from(digest: [u8; 32]) -> Digest

Converts to this type from the input type.

impl From<Digest> for [u8; 32]

fn from(digest: Digest) -> [u8; 32]

Converts to this type from the input type.

impl From<Digest> for ChainIdentifier

fn from(digest: CheckpointDigest) -> Self

Converts to this type from the input type.

impl FromStr for Digest

type Err = DigestParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Digest, <Digest as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Digest

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 LowerHex for Digest

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

Formats the value using the given formatter.

impl Ord for Digest

fn cmp(&self, other: &Digest) -> 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<[u8; 32]> for Digest

fn eq(&self, other: &[u8; 32]) -> 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 PartialEq<Digest> for [u8; 32]

fn eq(&self, other: &Digest) -> 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 PartialEq<Digest> for Vec<u8>

fn eq(&self, other: &Digest) -> 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 PartialEq<Vec<u8>> for Digest

fn eq(&self, other: &Vec<u8>) -> 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 PartialEq for Digest

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

fn partial_cmp(&self, other: &Digest) -> 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 Serialize for Digest

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl UpperHex for Digest

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

Formats the value using the given formatter.

impl Copy for Digest

impl Eq for Digest

impl StructuralPartialEq for Digest