Struct web3::types::H128

#[repr(C)]pub struct H128(pub [u8; 16]);

Implementations

impl H128

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

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

pub const fn zero() -> H128

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; 16]

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

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

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

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

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]) -> H128

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: &H128) -> 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 H128

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) -> H128

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) -> H128

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) -> H128

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 H128

Utilities using the rand crate.

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

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>(rng: &mut R) -> H128 where
    R: Rng + ?Sized, 

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

pub fn random() -> H128

Create a new hash with cryptographically random content.

Trait Implementations

impl AsMut<[u8]> for H128

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

Performs the conversion.

impl AsRef<[u8]> for H128

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

Performs the conversion.

impl BigEndianHash for H128

type Uint = U128

fn from_uint(value: &U128) -> H128

fn into_uint(&self) -> U128

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

type Output = H128

The resulting type after applying the & operator.

fn bitand(self, rhs: &'r H128) -> <&'l H128 as BitAnd<&'r H128>>::Output

Performs the & operation.

impl BitAnd<H128> for H128

type Output = H128

The resulting type after applying the & operator.

fn bitand(self, rhs: H128) -> <H128 as BitAnd<H128>>::Output

Performs the & operation.

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

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

Performs the &= operation.

impl BitAndAssign<H128> for H128

fn bitand_assign(&mut self, rhs: H128)

Performs the &= operation.

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

type Output = H128

The resulting type after applying the | operator.

fn bitor(self, rhs: &'r H128) -> <&'l H128 as BitOr<&'r H128>>::Output

Performs the | operation.

impl BitOr<H128> for H128

type Output = H128

The resulting type after applying the | operator.

fn bitor(self, rhs: H128) -> <H128 as BitOr<H128>>::Output

Performs the | operation.

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

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

Performs the |= operation.

impl BitOrAssign<H128> for H128

fn bitor_assign(&mut self, rhs: H128)

Performs the |= operation.

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

type Output = H128

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'r H128) -> <&'l H128 as BitXor<&'r H128>>::Output

Performs the ^ operation.

impl BitXor<H128> for H128

type Output = H128

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: H128) -> <H128 as BitXor<H128>>::Output

Performs the ^ operation.

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

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

Performs the ^= operation.

impl BitXorAssign<H128> for H128

fn bitxor_assign(&mut self, rhs: H128)

Performs the ^= operation.

impl Clone for H128

fn clone(&self) -> H128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for H128

impl Debug for H128

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

Formats the value using the given formatter.

impl Decodable for H128

fn decode(rlp: &Rlp<'_>) -> Result<H128, DecoderError>

Decode a value from RLP bytes

impl Default for H128

fn default() -> H128

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for H128

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

Deserialize this value from the given Serde deserializer.

impl Display for H128

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

Formats the value using the given formatter.

impl Encodable for H128

fn rlp_append(&self, s: &mut RlpStream)

Append a value to the stream

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

Get rlp-encoded bytes for this instance

impl Eq for H128

impl<'a> From<&'a [u8; 16]> for H128

fn from(bytes: &'a [u8; 16]) -> H128

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; 16]> for H128

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

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; 16]> for H128

fn from(bytes: [u8; 16]) -> H128

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 H128

type Err = FromHexError

The associated error which can be returned from parsing.

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

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<I> Index<I> for H128 where
    I: SliceIndex<[u8]>, 

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &<I as SliceIndex<[u8]>>::Output

Performs the indexing (container[index]) operation.

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

fn index_mut(&mut self, index: I) -> &mut <I as SliceIndex<[u8]>>::Output

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

impl LowerHex for H128

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

Formats the value using the given formatter.

impl Ord for H128

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<H128> for H128

fn eq(&self, other: &H128) -> 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 PartialOrd<H128> for H128

fn partial_cmp(&self, other: &H128) -> 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 Serialize for H128

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

Serialize this value into the given Serde serializer.

impl UpperHex for H128

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

Formats the value using the given formatter.