Struct monero::cryptonote::hash::Hash

#[repr(C)]
pub struct Hash(pub [u8; 32]);

Result of the Keccak-256 hashing function.

Implementations

impl Hash

pub const fn repeat_byte(byte: u8) -> Hash

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

pub const fn zero() -> Hash

Returns a new zero-initialized fixed hash.

pub const 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 const fn as_fixed_bytes(&self) -> &[u8; 32]

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

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

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

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

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 Hash

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 Hash

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.

impl Hash

pub fn null_hash() -> Hash

Create a null hash with all zeros.

pub fn hash(input: &[u8]) -> Hash

Hash a stream of bytes with the Keccak-256 hash function.

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

Return the 32-bytes hash array.

pub fn as_scalar(&self) -> PrivateKey

Return the scalar of the hash as a little endian number modulo l (curve order).

pub fn hash_to_scalar(input: &[u8]) -> PrivateKey

Hash a stream of bytes and return its scalar representation.

The hash function H is the same Keccak function that is used in CryptoNote. When the value of the hash function is interpreted as a scalar, it is converted into a little-endian integer and taken modulo l.

Trait Implementations

impl AsMut<[u8]> for Hash

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

Performs the conversion.

impl AsRef<[u8]> for Hash

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

Performs the conversion.

impl<'l, 'r> BitAnd<&'r Hash> for &'l Hash

type Output = Hash

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<Hash> for Hash

type Output = Hash

The resulting type after applying the & operator.

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

Performs the & operation.

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

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

Performs the &= operation.

impl BitAndAssign<Hash> for Hash

fn bitand_assign(&mut self, rhs: Hash)

Performs the &= operation.

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

type Output = Hash

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<Hash> for Hash

type Output = Hash

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

Performs the |= operation.

impl BitOrAssign<Hash> for Hash

fn bitor_assign(&mut self, rhs: Hash)

Performs the |= operation.

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

type Output = Hash

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<Hash> for Hash

type Output = Hash

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

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

Performs the ^= operation.

impl BitXorAssign<Hash> for Hash

fn bitxor_assign(&mut self, rhs: Hash)

Performs the ^= operation.

impl Clone for Hash

fn clone(&self) -> Hash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Hash

impl Debug for Hash

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

Formats the value using the given formatter.

impl Decodable for Hash

fn consensus_decode<D: Read>(d: &mut D) -> Result<Hash, Error>

Decode an object with a well-defined format.

impl Default for Hash

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Hash

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

Deserialize this value from the given Serde deserializer.

impl Display for Hash

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

Formats the value using the given formatter.

impl Encodable for Hash

fn consensus_encode<S: Write>(&self, s: &mut S) -> Result<usize, Error>

Encode an object with a well-defined format, should only ever error if the underlying Encoder errors.

impl Eq for Hash

impl<'a> From<&'a [u8; 32]> for Hash

fn from(bytes: &'a [u8; 32]) -> 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; 32]> for Hash

fn from(bytes: &'a mut [u8; 32]) -> 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<[u8; 32]> for Hash

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

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

Note

The given bytes are interpreted in big endian order.

impl FromStr for Hash

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Hash, 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 Hash for Hash

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<I> Index<I> for Hash 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 Hash where
    I: SliceIndex<[u8], Output = [u8]>, 

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

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

impl LowerHex for Hash

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

Formats the value using the given formatter.

impl Ord for Hash

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Hash> for Hash

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Hash> for Hash

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

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

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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 Hash

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

Serialize this value into the given Serde serializer.

impl StrictDecode for Hash

This is supported on crate feature strict_encoding_support only.

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for Hash

This is supported on crate feature strict_encoding_support only.

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

pub fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using [strict_encode()] function

impl UpperHex for Hash

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

Formats the value using the given formatter.