Struct FixedBytes

#[repr(transparent)]
pub struct FixedBytes<const N: usize>(pub [u8; N]);

Newtype wrapper for Solidity ABI encoding/decoding [u8; N] for 1 <= N <= 32 as fixed-size byte sequences.

Ref: https://docs.soliditylang.org/en/latest/types.html#fixed-size-byte-arrays

Tuple Fields

0: [u8; N]

Implementations

impl<const N: usize> FixedBytes<N>

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

Converts a reference to [u8; N] into a reference to FixedBytes<N> (without copying).

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

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

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

Converts this array of bytes into an array of ASCII characters, or returns None if any of the characters is non-ASCII.

Examples

#![feature(ascii_char)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

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

Converts this array of bytes into an array of ASCII characters, without checking whether they’re valid.

Safety

Every byte in the array must be in 0..=127, or else this is UB.

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

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

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

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

Example

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.

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<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> Borrow<[u8; N]> for FixedBytes<N>

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

Immutably 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> Decode for FixedBytes<N>

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<FixedBytes<N>, Error>

where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

fn decode_into<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, dst_: &mut MaybeUninit<FixedBytes<N>>, ) -> Result<DecodeFinished, Error>

where __CodecInputEdqy: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the 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> Encode for FixedBytes<N>

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

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<__CodecOutputReturn, __CodecUsingEncodedCallback>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

where __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn,

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

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

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

Converts to this type from the input type.

impl From<u8> for FixedBytes<1>

fn from(value: u8) -> FixedBytes<1>

Converts to this type from the input type.

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> SolDecode for FixedBytes<N>

where ByteCount<N>: SupportedFixedBytes,

type SolType = FixedBytes<N>

Equivalent Solidity ABI type representation.

fn from_sol_type( value: <FixedBytes<N> as SolDecode>::SolType, ) -> Result<FixedBytes<N>, Error>

Converts to Self from Self::SolType.

const SOL_NAME: &'static str = <<Self::SolType as SolTypeDecode>::AlloyType as AlloySolType>::SOL_NAME

Name of equivalent Solidity ABI type.

fn decode(data: &[u8]) -> Result<Self, Error>

Solidity ABI decode into this type.

impl<'a, const N: usize> SolEncode<'a> for FixedBytes<N>

where ByteCount<N>: SupportedFixedBytes,

type SolType = &'a FixedBytes<N>

Equivalent Solidity ABI type representation.

fn to_sol_type(&'a self) -> <FixedBytes<N> as SolEncode<'a>>::SolType

Converts from Self to Self::SolType via either a borrow (if possible), or a possibly expensive conversion otherwise.

const SOL_NAME: &'static str = <<Self::SolType as SolTypeEncode>::AlloyType as AlloySolType>::SOL_NAME

Name of equivalent Solidity ABI type.

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

Solidity ABI encode the value.

fn encode_to(&'a self, buffer: &mut [u8]) -> usize

Solidity ABI encode the value into the given buffer, and returns the number of bytes written.

fn encode_topic<H>(&'a self, hasher: H) -> [u8; 32]

where H: Fn(&[u8], &mut [u8; 32]),

Solidity ABI encode the value as a topic (i.e. an indexed event parameter).

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

where ByteCount<N>: SupportedFixedBytes,

fn encode_topic<H>(&self, _: H) -> [u8; 32]

where H: Fn(&[u8], &mut [u8; 32]),

Solidity ABI encode the value as a topic (i.e. an indexed event parameter).

fn topic_preimage(&self, buffer: &mut Vec<u8>)

Encode this type as input bytes for the hasher, when this type is member of a complex topic type (e.g. a member of array or struct/tuple).

fn default_topic_preimage(buffer: &mut Vec<u8>)

Self::topic_preimage equivalent for the default value representation of this type.

fn topic_preimage_size(&self) -> usize

Size in bytes of the Self::topic_preimage encoding of this type.

fn default_topic_preimage_size() -> usize

Self::topic_preimage_size equivalent for the default value representation of this type.

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

where ByteCount<N>: SupportedFixedBytes,

type AlloyType = FixedBytes<N>

Equivalent Solidity ABI type from [alloy_sol_types].

fn detokenize( token: <<FixedBytes<N> as SolTypeDecode>::AlloyType as SolType>::Token<'_>, ) -> Result<FixedBytes<N>, Error>

Detokenizes this type’s value from the given token.

fn decode(data: &[u8]) -> Result<Self, Error>

Solidity ABI decode into this type.

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

where ByteCount<N>: SupportedFixedBytes,

const DEFAULT_VALUE: <FixedBytes<N> as SolTokenType>::DefaultType = {transmute(0x0000000000000001): <ink_primitives::sol::FixedBytes<N> as ink_primitives::sol::types::SolTokenType>::DefaultType}

An encodable representation of the default value for this type.

type AlloyType = FixedBytes<N>

Equivalent Solidity ABI type from [alloy_sol_types].

fn tokenize(&self) -> <FixedBytes<N> as SolTokenType>::TokenType<'_>

Tokenizes the given value into a Self::AlloyType token.

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

Solidity ABI encode the value.

fn encode_to(&self, buffer: &mut [u8]) -> usize

Solidity ABI encode the value into the given buffer, and returns the number of bytes written.

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

type Identity = FixedBytes<N>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

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

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

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

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