Struct beacon::H32

#[repr(C)]
pub struct H32(_);

Fixed 384-bit hash.

Methods

impl H32

pub fn repeat_byte(byte: u8) -> H32

Returns a new fixed hash where all bits are set to the given byte.

pub fn zero() -> H32

Returns a new zero-initialized fixed hash.

pub fn len_bytes() -> usize

Returns the size of this hash in bytes.

pub fn as_bytes(&self) -> &[u8]

Extracts a byte slice containing the entire fixed hash.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Extracts a mutable byte slice containing the entire fixed hash.

pub fn as_fixed_bytes(&self) -> &[u8; 4]

Extracts a reference to the byte array containing the entire fixed hash.

pub fn as_fixed_bytes_mut(&mut self) -> &mut [u8; 4]

Extracts a reference to the byte array containing the entire fixed hash.

pub fn to_fixed_bytes(self) -> [u8; 4]

Returns the inner bytes array.

pub fn as_ptr(&self) -> *const u8

Returns a constant raw pointer to the value.

pub fn as_mut_ptr(&mut self) -> *mut u8

Returns a mutable raw pointer to the value.

pub fn assign_from_slice(&mut self, src: &[u8])

Assign the bytes from the byte slice src to self.

Note

The given bytes are interpreted in big endian order.

Panics

If the length of src and the number of bytes in self do not match.

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

Create a new fixed-hash from the given slice src.

Note

The given bytes are interpreted in big endian order.

Panics

If the length of src and the number of bytes in Self do not match.

pub fn covers(&self, b: &Self) -> bool

Returns true if all bits set in b are also set in self.

pub fn is_zero(&self) -> bool

Returns true if no bits are set.

impl H32

Utilities using the byteorder crate.

pub fn to_low_u64_be(&self) -> u64

Returns the lowest 8 bytes interpreted as big-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn to_low_u64_le(&self) -> u64

Returns the lowest 8 bytes interpreted as little-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn to_low_u64_ne(&self) -> u64

Returns the lowest 8 bytes interpreted as native-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

pub fn from_low_u64_be(val: u64) -> Self

Creates a new hash type from the given u64 value.

Note

• The given u64 value is interpreted as big endian.
• Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

pub fn from_low_u64_le(val: u64) -> Self

Creates a new hash type from the given u64 value.

Note

• The given u64 value is interpreted as little endian.
• Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

pub fn from_low_u64_ne(val: u64) -> Self

Creates a new hash type from the given u64 value.

Note

• The given u64 value is interpreted as native endian.
• Ignores the most significant bits of the given value if the hash type has less than 8 bytes.

impl H32

Utilities using the rand crate.

pub fn randomize_using<R: ?Sized>(&mut self, rng: &mut R) where
    R: Rng, 

Assign self to a cryptographically random value using the given random number generator.

pub fn randomize(&mut self)

Assign self to a cryptographically random value.

pub fn random_using<R: ?Sized>(rng: &mut R) -> Self where
    R: Rng, 

Create a new hash with cryptographically random content using the given random number generator.

pub fn random() -> Self

Create a new hash with cryptographically random content.

Trait Implementations

impl PartialOrd<H32> for H32

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 AsMut<[u8]> for H32

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl Copy for H32

impl PartialEq<H32> for H32

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

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

#[must_use]

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

This method tests for !=.

impl AsRef<[u8]> for H32

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

Performs the conversion.

impl Default for H32

fn default() -> Self

Returns the "default value" for a type.

impl From<[u8; 4]> for H32

fn from(bytes: [u8; 4]) -> Self

Constructs a hash type from the given bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl<'a> From<&'a [u8; 4]> for H32

fn from(bytes: &'a [u8; 4]) -> Self

Constructs a hash type from the given reference to the bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl<'a> From<&'a mut [u8; 4]> for H32

fn from(bytes: &'a mut [u8; 4]) -> Self

Constructs a hash type from the given reference to the mutable bytes array of fixed length.

Note

The given bytes are interpreted in big endian order.

impl From<H32> for [u8; 4]

fn from(s: H32) -> Self

Performs the conversion.

impl Clone for H32

fn clone(&self) -> H32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for H32

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

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for H32

impl Display for H32

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

Formats the value using the given formatter.

impl Debug for H32

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

Formats the value using the given formatter.

impl Hash for H32

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

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<'l, 'r> BitAnd<&'r H32> for &'l H32

type Output = H32

The resulting type after applying the & operator.

fn bitand(self, rhs: &'r H32) -> Self::Output

Performs the & operation.

impl BitAnd<H32> for H32

type Output = H32

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<'l, 'r> BitOr<&'r H32> for &'l H32

type Output = H32

The resulting type after applying the | operator.

fn bitor(self, rhs: &'r H32) -> Self::Output

Performs the | operation.

impl BitOr<H32> for H32

type Output = H32

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<'l, 'r> BitXor<&'r H32> for &'l H32

type Output = H32

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'r H32) -> Self::Output

Performs the ^ operation.

impl BitXor<H32> for H32

type Output = H32

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<'r> BitAndAssign<&'r H32> for H32

fn bitand_assign(&mut self, rhs: &'r H32)

Performs the &= operation.

impl BitAndAssign<H32> for H32

fn bitand_assign(&mut self, rhs: H32)

Performs the &= operation.

impl<'r> BitOrAssign<&'r H32> for H32

fn bitor_assign(&mut self, rhs: &'r H32)

Performs the |= operation.

impl BitOrAssign<H32> for H32

fn bitor_assign(&mut self, rhs: H32)

Performs the |= operation.

impl<'r> BitXorAssign<&'r H32> for H32

fn bitxor_assign(&mut self, rhs: &'r H32)

Performs the ^= operation.

impl BitXorAssign<H32> for H32

fn bitxor_assign(&mut self, rhs: H32)

Performs the ^= operation.

impl<I> Index<I> for H32 where
    I: SliceIndex<[u8]>, 

type Output = I::Output

The returned type after indexing.

fn index(&self, index: I) -> &I::Output

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for H32 where
    I: SliceIndex<[u8], Output = [u8]>, 

fn index_mut(&mut self, index: I) -> &mut I::Output

Performs the mutable indexing (container[index]) operation.

impl FromStr for H32

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<H32, FromHexError>

Creates a hash type instance from the given string.

Note

The given input string is interpreted in big endian.

Errors

• When encountering invalid non hex-digits
• Upon empty string input or invalid input length in general

impl LowerHex for H32

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

Formats the value using the given formatter.

impl UpperHex for H32

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

Formats the value using the given formatter.

impl Encode for H32

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Convert self to a slice and then invoke the given closure with it.

fn encode_to<T>(&self, dest: &mut T) where
    T: Output, 

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

impl Decode for H32

fn decode<I: Input>(input: &mut I) -> Option<Self>

Attempt to deserialise the value from input.

impl Serialize for H32

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for H32

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

Deserialize this value from the given Serde deserializer.

impl Prefixable for H32

fn prefixed() -> bool

Whether the item is prefixed.

impl Encode for H32

fn encode_to<W: Output>(&self, dest: &mut W)

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

impl Decode for H32

fn decode_as<I: Input>(input: &mut I) -> Option<(Self, usize)>

Attempt to deserialise the value from input. Return the number of bytes read as the second parameter.

fn decode<I>(value: &mut I) -> Option<Self> where
    I: Input, 

Attempt to deserialise the value from input.

impl Hashable for H32

fn hash<H: Hasher>(&self) -> H::Out

fn truncated_hash<H>(&self) -> <H as Hasher>::Out where
    H: Hasher, 

impl Composite for H32

impl Distribution<H32> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> H32

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.