Struct revm_primitives::bits::B256

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

revm 256 bits type.

Tuple Fields

0: [u8; 32]

Implementations

impl B256

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

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

pub const fn zero() -> B256

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 B256

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 B256

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) -> Selfwhere R: Rng + ?Sized,

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.

Methods from Deref<Target = [u8; 32]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn each_ref(&self) -> [&T; N]

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

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

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

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

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

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

Trait Implementations

impl AsMut<[u8]> for B256

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for B256

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

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 32]> for B256

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

Converts this type into a shared reference of the (usually inferred) input type.

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

type Output = B256

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<B256> for B256

type Output = B256

The resulting type after applying the & operator.

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

Performs the & operation.

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

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

Performs the &= operation.

impl BitAndAssign<B256> for B256

fn bitand_assign(&mut self, rhs: B256)

Performs the &= operation.

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

type Output = B256

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<B256> for B256

type Output = B256

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

Performs the |= operation.

impl BitOrAssign<B256> for B256

fn bitor_assign(&mut self, rhs: B256)

Performs the |= operation.

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

type Output = B256

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<B256> for B256

type Output = B256

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

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

Performs the ^= operation.

impl BitXorAssign<B256> for B256

fn bitxor_assign(&mut self, rhs: B256)

Performs the ^= operation.

impl Clone for B256

fn clone(&self) -> B256

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for B256

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

Formats the value using the given formatter.

impl Default for B256

fn default() -> Self

Returns the “default value” for a type.

impl Deref for B256

type Target = [u8; 32]

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for B256

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

Formats the value using the given formatter.

impl Distribution<B256> for Standard

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

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

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>where R: Rng, Self: Sized,

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

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

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

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 B256

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 B256

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 From<B160> for B256

fn from(value: B160) -> B256

Converts to this type from the input type.

impl From<B256> for [u8; 32]

fn from(s: B256) -> Self

Converts to this type from the input type.

impl From<B256> for B160

fn from(value: B256) -> B160

Converts to this type from the input type.

impl From<B256> for H256

fn from(fr: B256) -> Self

Converts to this type from the input type.

impl From<B256> for U256

fn from(fr: B256) -> Self

Converts to this type from the input type.

impl From<B256> for U256

fn from(fr: B256) -> Self

Converts to this type from the input type.

impl From<H256> for B256

fn from(fr: H256) -> Self

Converts to this type from the input type.

impl From<U256> for B256

fn from(fr: U256) -> Self

Converts to this type from the input type.

impl From<Uint<256, 4>> for B256

fn from(fr: U256) -> Self

Converts to this type from the input type.

impl FromStr for B256

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

type Err = FromHexError

The associated error which can be returned from parsing.

impl Hash for B256

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for B256where 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 B256

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

Formats the value using the given formatter.

impl Ord for B256

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<B256> for B256

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<B256> for B256

fn partial_cmp(&self, other: &Self) -> 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 UpperHex for B256

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

Formats the value using the given formatter.

impl Copy for B256

impl Eq for B256