Struct Hash 

pub struct Hash<const SIZE: usize>(/* private fields */);

A blake2b hash digest; typically 28 or 32 bytes long.

There are several ways to construct Self, but fundamentally:

• Conversions from static byte arrays of known sizes are infaillible:

  assert_eq!(
    <Hash<28>>::from([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).to_string(),
    "00000000000000000000000000000000000000000000000000000000",
  );

• Conversions from vectors or slices are possible but faillible:

  // Vectors contains exactly 28 elements
  assert!(
    <Hash<28>>::try_from(vec![0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0])
        .is_ok()
  );
  
  // Vectors still contains only 28 elements
  assert!(
    <Hash<32>>::try_from(vec![0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0])
        .is_err()
  );

• Conversions from base16-encoded text strings are also possible:

  // The text string is indeed 56 character-long.
  assert!(
    <Hash<28>>::try_from("00000000000000000000000000000000000000000000000000000000")
        .is_ok()
  );

• For the latter, we also provide the hash! macro.

Implementations

impl Hash<28>

pub fn new<T: AsRef<[u8]>>(preimage: T) -> Self

impl Hash<32>

pub fn new<T: AsRef<[u8]>>(preimage: T) -> Self

impl<const SIZE: usize> Hash<SIZE>

pub const SIZE: usize = SIZE

Trait Implementations

impl<const SIZE: usize> AsRef<[u8]> for Hash<SIZE>

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

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

impl<const SIZE: usize> Clone for Hash<SIZE>

fn clone(&self) -> Hash<SIZE>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const SIZE: usize> Debug for Hash<SIZE>

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

Formats the value using the given formatter.

impl<'bytes, Ctx, const SIZE: usize> Decode<'bytes, Ctx> for Hash<SIZE>

fn decode( __d777: &mut Decoder<'bytes>, __ctx777: &mut Ctx, ) -> Result<Hash<SIZE>, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl<const SIZE: usize> Display for Hash<SIZE>

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

Formats the value using the given formatter.

impl<Ctx, const SIZE: usize> Encode<Ctx> for Hash<SIZE>

fn encode<__W777>( &self, __e777: &mut Encoder<__W777>, __ctx777: &mut Ctx, ) -> Result<(), Error<__W777::Error>>

where __W777: Write,

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

impl From<&Credential> for Hash<28>

fn from(credential: &Credential) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<&Hash<SIZE>> for Hash<SIZE>

fn from(hash: &Hash<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<&Hash<SIZE>> for Hash<SIZE>

fn from(hash: &Hash<SIZE>) -> Self

Converts to this type from the input type.

impl From<&PlutusScript> for Hash<28>

fn from(PlutusScript: &PlutusScript) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<[u8; SIZE]> for Hash<SIZE>

fn from(hash: [u8; SIZE]) -> Self

Converts to this type from the input type.

impl From<Hash<28>> for Hash28

fn from(hash28: Hash<28>) -> Self

Converts to this type from the input type.

impl From<Hash<32>> for Hash32

fn from(hash32: Hash<32>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<Hash<SIZE>> for [u8; SIZE]

fn from(hash: Hash<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<Hash<SIZE>> for Hash<SIZE>

fn from(hash: Hash<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<Hash<SIZE>> for Hash<SIZE>

fn from(hash: Hash<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> FromStr for Hash<SIZE>

type Err = String

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<const SIZE: usize> Ord for Hash<SIZE>

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

Restrict a value to a certain interval.

impl<const SIZE: usize> PartialEq for Hash<SIZE>

fn eq(&self, other: &Hash<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 SIZE: usize> PartialOrd for Hash<SIZE>

fn partial_cmp(&self, other: &Hash<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 SIZE: usize> TryFrom<&str> for Hash<SIZE>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self>

Performs the conversion.

impl<const SIZE: usize> TryFrom<Vec<u8>> for Hash<SIZE>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self>

Performs the conversion.

impl<const SIZE: usize> Copy for Hash<SIZE>

impl<const SIZE: usize> Eq for Hash<SIZE>

impl<const SIZE: usize> StructuralPartialEq for Hash<SIZE>