Type Alias B256

pub type B256 = FixedBytes<32>;

32-byte fixed byte-array type.

Aliased Type

struct B256(pub [u8; 32]);

Fields

0: [u8; 32]

Implementations

impl<const N: usize> FixedBytes<N>

pub const ZERO: FixedBytes<N>

Array of Zero bytes.

pub const fn new(bytes: [u8; N]) -> FixedBytes<N>

Wraps the given byte array in FixedBytes.

pub const fn with_last_byte(x: u8) -> FixedBytes<N>

Creates a new FixedBytes with the last byte set to x.

pub const fn repeat_byte(byte: u8) -> FixedBytes<N>

Creates a new FixedBytes where all bytes are set to byte.

pub const fn len_bytes() -> usize

Returns the size of this byte array (N).

pub const fn concat_const<const M: usize, const Z: usize>( self, other: FixedBytes<M>, ) -> FixedBytes<Z>

Concatenate two FixedBytes.

Due to constraints in the language, the user must specify the value of the output size Z.

Panics

Panics if Z is not equal to N + M.

pub fn from_slice(src: &[u8]) -> FixedBytes<N>

Create a new FixedBytes from the given slice src.

For a fallible version, use the TryFrom<&[u8]> implementation.

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 left_padding_from(value: &[u8]) -> FixedBytes<N>

Create a new FixedBytes from the given slice src, left-padding it with zeroes if necessary.

Note

The given bytes are interpreted in big endian order.

Panics

Panics if src.len() > N.

pub fn right_padding_from(value: &[u8]) -> FixedBytes<N>

Create a new FixedBytes from the given slice src, right-padding it with zeroes if necessary.

Note

The given bytes are interpreted in big endian order.

Panics

Panics if src.len() > N.

pub const fn as_slice(&self) -> &[u8]

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

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

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

pub fn covers(&self, other: &FixedBytes<N>) -> bool

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

pub const fn const_covers(self, other: FixedBytes<N>) -> bool

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

pub const fn const_eq(&self, other: &FixedBytes<N>) -> bool

Compile-time equality. NOT constant-time equality.

pub fn is_zero(&self) -> bool

Returns true if no bits are set.

pub const fn const_is_zero(&self) -> bool

Returns true if no bits are set.

pub const fn bit_and(self, rhs: FixedBytes<N>) -> FixedBytes<N>

Computes the bitwise AND of two FixedBytes.

pub const fn bit_or(self, rhs: FixedBytes<N>) -> FixedBytes<N>

Computes the bitwise OR of two FixedBytes.

pub const fn bit_xor(self, rhs: FixedBytes<N>) -> FixedBytes<N>

Computes the bitwise XOR of two FixedBytes.

Trait Implementations

impl<const N: usize> AsMut<[u8]> for FixedBytes<N>

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

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

impl<const N: usize> AsMut<[u8; N]> for FixedBytes<N>

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

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

impl<const N: usize> AsRef<[u8]> for FixedBytes<N>

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

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

impl<const N: usize> AsRef<[u8; N]> for FixedBytes<N>

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

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

impl<const N: usize> BitAnd for FixedBytes<N>

type Output = FixedBytes<N>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const N: usize> BitAndAssign for FixedBytes<N>

fn bitand_assign(&mut self, rhs: FixedBytes<N>)

Performs the &= operation.

impl<const N: usize> BitOr for FixedBytes<N>

type Output = FixedBytes<N>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const N: usize> BitOrAssign for FixedBytes<N>

fn bitor_assign(&mut self, rhs: FixedBytes<N>)

Performs the |= operation.

impl<const N: usize> BitXor for FixedBytes<N>

type Output = FixedBytes<N>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<const N: usize> BitXorAssign for FixedBytes<N>

fn bitxor_assign(&mut self, rhs: FixedBytes<N>)

Performs the ^= operation.

impl<const N: usize> Borrow<[u8]> for FixedBytes<N>

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

Immutably borrows from an owned value.

impl<const N: usize> Borrow<[u8; N]> for FixedBytes<N>

fn borrow(&self) -> &[u8; N]

Immutably borrows from an owned value.

impl<const N: usize> BorrowMut<[u8]> for FixedBytes<N>

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

Mutably borrows from an owned value.

impl<const N: usize> BorrowMut<[u8; N]> for FixedBytes<N>

fn borrow_mut(&mut self) -> &mut [u8; N]

Mutably borrows from an owned value.

impl<const N: usize> Clone for FixedBytes<N>

fn clone(&self) -> FixedBytes<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for FixedBytes<N>

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

Formats the value using the given formatter.

impl<const N: usize> Decodable for FixedBytes<N>

fn decode(buf: &mut &[u8]) -> Result<FixedBytes<N>, Error>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.

impl<const N: usize> Default for FixedBytes<N>

fn default() -> FixedBytes<N>

Returns the “default value” for a type.

impl<const N: usize> Deref for FixedBytes<N>

type Target = [u8; N]

The resulting type after dereferencing.

fn deref(&self) -> &<FixedBytes<N> as Deref>::Target

Dereferences the value.

impl<const N: usize> DerefMut for FixedBytes<N>

fn deref_mut(&mut self) -> &mut <FixedBytes<N> as Deref>::Target

Mutably dereferences the value.

impl<'de, const N: usize> Deserialize<'de> for FixedBytes<N>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Display for FixedBytes<N>

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

Formats the value using the given formatter.

impl<const N: usize> Encodable for FixedBytes<N>

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes.

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.

impl<const N: usize> From<&[u8; N]> for FixedBytes<N>

fn from(bytes: &[u8; N]) -> FixedBytes<N>

Converts to this type from the input type.

impl<const N: usize> From<&mut [u8; N]> for FixedBytes<N>

fn from(bytes: &mut [u8; N]) -> FixedBytes<N>

Converts to this type from the input type.

impl<const N: usize> From<[u8; N]> for FixedBytes<N>

fn from(value: [u8; N]) -> FixedBytes<N>

Converts to this type from the input type.

impl From<Signed<256, 4>> for FixedBytes<32>

fn from(value: Signed<256, 4>) -> FixedBytes<32>

Converts a fixed-width unsigned integer into a fixed byte array by interpreting the bytes as big-endian.

impl From<Uint<256, 4>> for FixedBytes<32>

fn from(value: Uint<256, 4>) -> FixedBytes<32>

Converts a fixed-width unsigned integer into a fixed byte array by interpreting the bytes as big-endian.

impl<const N: usize> FromHex for FixedBytes<N>

type Error = FromHexError

The associated error which can be returned from parsing.

fn from_hex<T>( hex: T, ) -> Result<FixedBytes<N>, <FixedBytes<N> as FromHex>::Error>

where T: AsRef<[u8]>,

Creates an instance of type Self from the given hex string, or fails with a custom error type.

impl<const N: usize> FromStr for FixedBytes<N>

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<FixedBytes<N>, <FixedBytes<N> as FromStr>::Err>

Parses a string s to return a value of this type.

impl<const N: usize> Hash for FixedBytes<N>

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<__IdxT, const N: usize> Index<__IdxT> for FixedBytes<N>

where [u8; N]: Index<__IdxT>,

type Output = <[u8; N] as Index<__IdxT>>::Output

The returned type after indexing.

fn index(&self, idx: __IdxT) -> &<FixedBytes<N> as Index<__IdxT>>::Output

Performs the indexing (container[index]) operation.

impl<__IdxT, const N: usize> IndexMut<__IdxT> for FixedBytes<N>

where [u8; N]: IndexMut<__IdxT>,

fn index_mut( &mut self, idx: __IdxT, ) -> &mut <FixedBytes<N> as Index<__IdxT>>::Output

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

impl<const N: usize> IntoIterator for FixedBytes<N>

where [u8; N]: IntoIterator,

type Item = <[u8; N] as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <[u8; N] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <FixedBytes<N> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<const N: usize> LowerHex for FixedBytes<N>

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

Formats the value using the given formatter.

impl<const N: usize> MaxEncodedLenAssoc for FixedBytes<N>

const LEN: usize

The maximum length.

impl<const N: usize> Not for FixedBytes<N>

type Output = FixedBytes<N>

The resulting type after applying the ! operator.

fn not(self) -> <FixedBytes<N> as Not>::Output

Performs the unary ! operation.

impl<const N: usize> Ord for FixedBytes<N>

fn cmp(&self, other: &FixedBytes<N>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize> PartialEq<&[u8]> for FixedBytes<N>

fn eq(&self, other: &&[u8]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialEq<&[u8; N]> for FixedBytes<N>

fn eq(&self, other: &&[u8; N]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialEq<[u8]> for FixedBytes<N>

fn eq(&self, other: &[u8]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialEq<[u8; N]> for FixedBytes<N>

fn eq(&self, other: &[u8; N]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialEq for FixedBytes<N>

fn eq(&self, other: &FixedBytes<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> PartialOrd<&[u8]> for FixedBytes<N>

fn partial_cmp(&self, other: &&[u8]) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> PartialOrd<[u8]> for FixedBytes<N>

fn partial_cmp(&self, other: &[u8]) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> PartialOrd for FixedBytes<N>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> Serialize for FixedBytes<N>

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<const N: usize> TryFrom<&[u8]> for FixedBytes<N>

Tries to create a FixedBytes<N> by copying from a slice &[u8]. Succeeds if slice.len() == N.

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from( slice: &[u8], ) -> Result<FixedBytes<N>, <FixedBytes<N> as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<&mut [u8]> for FixedBytes<N>

Tries to create a FixedBytes<N> by copying from a mutable slice &mut [u8]. Succeeds if slice.len() == N.

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from( slice: &mut [u8], ) -> Result<FixedBytes<N>, <FixedBytes<N> as TryFrom<&mut [u8]>>::Error>

Performs the conversion.

impl<const N: usize> UpperHex for FixedBytes<N>

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

Formats the value using the given formatter.

impl<const N: usize> Copy for FixedBytes<N>

impl<const N: usize> Eq for FixedBytes<N>

impl MaxEncodedLen<alloy_primitives::::bits::rlp::{impl#10}::{constant#0}> for FixedBytes<32>

impl<const N: usize> StructuralPartialEq for FixedBytes<N>