[][src]Struct libra_crypto::hash::HashValue

pub struct HashValue { /* fields omitted */ }

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


impl HashValue[src]

pub const LENGTH: usize[src]

The length of the hash in bytes.

pub const LENGTH_IN_BITS: usize[src]

The length of the hash in bits.

pub const LENGTH_IN_NIBBLES: usize[src]

The length of the hash in nibbles.

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

Create a new HashValue from a byte array.

pub fn from_slice(src: &[u8]) -> Result<Self>[src]

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

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

Dumps into a vector.

pub const fn zero() -> Self[src]

Creates a zero-initialized instance.

pub fn random() -> Self[src]

Create a cryptographically random instance.

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

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

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

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 iter_bits(&self) -> HashValueBitIterator<'_>

Notable traits for HashValueBitIterator<'a>

impl<'a> Iterator for HashValueBitIterator<'a> type Item = bool;

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

pub fn from_bit_iter(iter: impl ExactSizeIterator<Item = bool>) -> Result<Self>[src]

Constructs a HashValue from an iterator of bits.

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

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

pub fn common_prefix_nibbles_len(&self, other: HashValue) -> usize[src]

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

pub fn get_nibble(&self, index: usize) -> Nibble[src]

Returns the index-th nibble.

pub fn short_str(&self) -> ShortHexStr[src]

Returns first 4 bytes as hex-formatted string

pub fn to_hex(&self) -> String[src]

Full hex representation of a given hash value.

pub fn from_hex(hex_str: &str) -> Result<Self>[src]

Parse a given hex string to a hash value.

Trait Implementations

impl Arbitrary for HashValue[src]

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. Read more

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

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

impl AsRef<[u8; 32]> for HashValue[src]

impl Binary for HashValue[src]

impl Clone for HashValue[src]

impl Copy for HashValue[src]

impl Debug for HashValue[src]

impl Default for HashValue[src]

impl<'de> Deserialize<'de> for HashValue[src]

impl Display for HashValue[src]

Will print shortened (4 bytes) hash

impl Eq for HashValue[src]

impl From<HashValue> for Bytes[src]

impl FromStr for HashValue[src]

type Err = Error

The associated error which can be returned from parsing.

impl Hash for HashValue[src]

impl Index<usize> for HashValue[src]

type Output = u8

The returned type after indexing.

impl LowerHex for HashValue[src]

impl Ord for HashValue[src]

impl PartialEq<HashValue> for HashValue[src]

impl PartialOrd<HashValue> for HashValue[src]

impl Serialize for HashValue[src]

impl StructuralEq for HashValue[src]

impl StructuralPartialEq for HashValue[src]

Auto Trait Implementations

impl RefUnwindSafe for HashValue

impl Send for HashValue

impl Sync for HashValue

impl Unpin for HashValue

impl UnwindSafe for HashValue

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> TestOnlyHash for T where
    T: Serialize + ?Sized

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,