Struct ObjectDigest 

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

The digest of an Object.

Implementations

impl ObjectDigest

pub const LENGTH: usize = Digest::LENGTH

A constant representing the length of the digest in bytes.

pub const ZERO: Self

A constant representing a zero digest.

pub const MIN: Self

The lexicographically minimum digest.

pub const MAX: Self

The lexicographically maximum digest.

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

Generates a new digest from the provided 32 byte array.

pub fn random_with<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 fn random() -> Self

Available on crate feature rand only.

Generates a new random digest.

pub const fn as_digest(&self) -> &Digest

Returns a reference to the underlying Digest.

pub const fn into_digest(self) -> Digest

Returns the underlying Digest.

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

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

Generates a digest from bytes.

pub const fn next_lexicographical(&self) -> Self

Returns the next digest in byte-increasing order.

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

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

impl ObjectDigest

pub const OBJECT_DELETED: Self

A marker that signifies the object is deleted.

pub const OBJECT_WRAPPED: Self

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

pub const OBJECT_CANCELED: Self

A marker that signifies the object is canceled.

pub fn is_alive(&self) -> bool

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

pub fn is_deleted(&self) -> bool

Returns whether the digest represents a deleted object.

pub fn is_wrapped(&self) -> bool

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

Trait Implementations

impl Arbitrary for ObjectDigest

Available on crate feature proptest only.

type Parameters = ()

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

type Strategy = BoxedStrategy<ObjectDigest>

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

fn arbitrary_with( args_shared: <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; 32]> for ObjectDigest

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

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

impl AsRef<[u8]> for ObjectDigest

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

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

impl Clone for ObjectDigest

fn clone(&self) -> ObjectDigest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ObjectDigest

impl Debug for ObjectDigest

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

Formats the value using the given formatter.

impl Default for ObjectDigest

fn default() -> ObjectDigest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ObjectDigest

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ObjectDigest

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

Formats the value using the given formatter.

impl Eq for ObjectDigest

impl From<Digest> for ObjectDigest

fn from(digest: Digest) -> 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<ObjectDigest> for [u8; 32]

fn from(digest: ObjectDigest) -> Self

Converts to this type from the input type.

impl From<[u8; 32]> for ObjectDigest

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

Converts to this type from the input type.

impl FromStr for ObjectDigest

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 ObjectDigest

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 ObjectDigest

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

Formats the value using the given formatter.

impl Ord for ObjectDigest

fn cmp(&self, other: &ObjectDigest) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ObjectDigest

fn eq(&self, other: &ObjectDigest) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ObjectDigest

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

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ObjectDigest

impl UpperHex for ObjectDigest

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

Formats the value using the given formatter.