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 = %x20 32OCTET

Due to historical reasons, even though a Digest has a fixed-length of 32, Sui’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 = 32usize

A constant representing the length of a digest in bytes.

pub const ZERO: Self = _

A constant representing a zero digest.

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

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

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

where R: RngCore + CryptoRng,

Available on crate feature rand only.

Generates a new digest from the provided random number generator.

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: AsRef<[u8]>>(base58: T) -> Result<Self, DigestParseError>

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: AsRef<[u8]>>(bytes: T) -> Result<Self, DigestParseError>

Generates a digest from bytes.

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: <Self as Arbitrary>::Parameters) -> Self::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 copy 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

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<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Digest

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

Formats the value using the given formatter.

impl From<[u8; 32]> for Digest

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

Converts to this type from the input type.

impl From<CheckpointContentsDigest> for Digest

fn from(digest: CheckpointContentsDigest) -> Self

Converts to this type from the input type.

impl From<CheckpointDigest> for Digest

fn from(digest: CheckpointDigest) -> Self

Converts to this type from the input type.

impl From<ConsensusCommitDigest> for Digest

fn from(digest: ConsensusCommitDigest) -> Self

Converts to this type from the input type.

impl From<Digest> for [u8; 32]

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for CheckpointContentsDigest

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for CheckpointDigest

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for ConsensusCommitDigest

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for EffectsAuxiliaryDataDigest

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for ObjectDigest

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for TransactionDigest

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for TransactionEffectsDigest

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for TransactionEventsDigest

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<EffectsAuxiliaryDataDigest> for Digest

fn from(digest: EffectsAuxiliaryDataDigest) -> Self

Converts to this type from the input type.

impl From<ObjectDigest> for Digest

fn from(digest: ObjectDigest) -> Self

Converts to this type from the input type.

impl From<TransactionDigest> for Digest

fn from(digest: TransactionDigest) -> Self

Converts to this type from the input type.

impl From<TransactionEffectsDigest> for Digest

fn from(digest: TransactionEffectsDigest) -> Self

Converts to this type from the input type.

impl From<TransactionEventsDigest> for Digest

fn from(digest: TransactionEventsDigest) -> 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<Self, Self::Err>

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

impl Hash for Digest

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

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

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 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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Digest

impl Eq for Digest

impl StructuralPartialEq for Digest