Struct diem_crypto::hash::HashValue

pub struct HashValue { /* fields omitted */ }

Output value of our hash function. Intentionally opaque for safety and modularity.

Implementations

impl HashValue

pub const LENGTH: usize

The length of the hash in bytes.

pub const LENGTH_IN_BITS: usize

The length of the hash in bits.

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

Create a new HashValue from a byte array.

pub fn from_slice<T: AsRef<[u8]>>(bytes: T) -> Result<Self, HashValueParseError>

Create from a slice (e.g. retrieved from storage).

pub fn to_vec(&self) -> Vec<u8>

Dumps into a vector.

pub const fn zero() -> Self

Creates a zero-initialized instance.

pub fn random() -> Self

Create a cryptographically random instance.

pub fn random_with_rng<R: Rng>(rng: &mut R) -> Self

Creates a random instance with given rng. Useful in unit tests.

pub fn sha3_256_of(buffer: &[u8]) -> Self

Convenience function that computes a HashValue internally equal to the sha3_256 of a byte buffer. It will handle hasher creation, data feeding and finalization.

Note this will not result in the <T as CryptoHash>::hash() for any reasonable struct T, as this computes a sha3 without any ornaments.

pub fn bit(&self, index: usize) -> bool

Returns the index-th bit in the bytes.

pub fn nibble(&self, index: usize) -> u8

Returns the index-th nibble in the bytes.

pub fn iter_bits(&self) -> HashValueBitIterator<'_>

Returns a HashValueBitIterator over all the bits that represent this HashValue.

pub fn from_bit_iter(
    iter: impl ExactSizeIterator<Item = bool>
) -> Result<Self, HashValueParseError>

Constructs a HashValue from an iterator of bits.

pub fn common_prefix_bits_len(&self, other: HashValue) -> usize

Returns the length of common prefix of self and other in bits.

pub fn to_hex(&self) -> String

Full hex representation of a given hash value.

pub fn to_hex_literal(&self) -> String

Full hex representation of a given hash value with 0x prefix.

pub fn from_hex<T: AsRef<[u8]>>(hex: T) -> Result<Self, HashValueParseError>

Parse a given hex string to a hash value.

pub fn from_u64(v: u64) -> Self

Create a hash value whose contents are just the given integer. Useful for generating basic mock hash values.

Ex: HashValue::from_u64(0x1234) => HashValue([0, .., 0, 0x12, 0x34])

Trait Implementations

impl Arbitrary for HashValue

type Parameters = <[u8; 32] as Arbitrary>::Parameters

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

type Strategy = Map<<[u8; 32] as Arbitrary>::Strategy, fn(_: [u8; 32]) -> Self>

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

fn arbitrary_with(_top: Self::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 HashValue

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

Performs the conversion.

impl Binary for HashValue

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

Formats the value using the given formatter.

impl Clone for HashValue

fn clone(&self) -> HashValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HashValue

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

Formats the value using the given formatter.

impl Default for HashValue

fn default() -> Self

Returns the “default value” for a type.

impl Deref for HashValue

type Target = [u8; 32]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for HashValue

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for HashValue

Will print shortened (4 bytes) hash

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

Formats the value using the given formatter.

impl From<HashValue> for Bytes

fn from(value: HashValue) -> Bytes

Performs the conversion.

impl FromStr for HashValue

type Err = HashValueParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, HashValueParseError>

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

impl Hash for HashValue

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, 

Feeds a slice of this type into the given Hasher.

impl Index<usize> for HashValue

type Output = u8

The returned type after indexing.

fn index(&self, s: usize) -> &u8

Performs the indexing (container[index]) operation.

impl LowerHex for HashValue

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

Formats the value using the given formatter.

impl Ord for HashValue

fn cmp(&self, other: &HashValue) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<HashValue> for HashValue

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<HashValue> for HashValue

fn partial_cmp(&self, other: &HashValue) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for HashValue

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 HashValue

impl Eq for HashValue

impl StructuralEq for HashValue

impl StructuralPartialEq for HashValue