Trait SolInterface

pub trait SolInterface: Sized {
    const NAME: &'static str;
    const MIN_DATA_LENGTH: usize;
    const COUNT: usize;

    // Required methods
    fn selector(&self) -> [u8; 4];
    fn selector_at(i: usize) -> Option<[u8; 4]>;
    fn valid_selector(selector: [u8; 4]) -> bool;
    fn abi_decode_raw(
        selector: [u8; 4],
        data: &[u8],
        validate: bool,
    ) -> Result<Self>;
    fn abi_encoded_size(&self) -> usize;
    fn abi_encode_raw(&self, out: &mut Vec<u8>);

    // Provided methods
    fn type_check(selector: [u8; 4]) -> Result<()> { ... }
    fn selectors() -> Selectors<Self>  { ... }
    fn abi_encode(&self) -> Vec<u8>  { ... }
    fn abi_decode(data: &[u8], validate: bool) -> Result<Self> { ... }
}

A collection of ABI-encodable call-like types. This currently includes SolCall and SolError.

This trait assumes that the implementing type always has a selector, and thus encoded/decoded data is always at least 4 bytes long.

This trait is implemented for Infallible to represent an empty interface. This is used by GenericContractError.

Implementer’s Guide

It should not be necessary to implement this trait manually. Instead, use the sol! procedural macro to parse Solidity syntax into types that implement this trait.

Required Associated Constants

const NAME: &'static str

The name of this type.

const MIN_DATA_LENGTH: usize

The minimum length of the data for this type.

This does not include the selector’s length (4).

const COUNT: usize

The number of variants.

Required Methods

fn selector(&self) -> [u8; 4]

The selector of this instance.

fn selector_at(i: usize) -> Option<[u8; 4]>

The selector of this type at the given index, used in selectors.

This must return None if i >= Self::COUNT, and Some with a different selector otherwise.

fn valid_selector(selector: [u8; 4]) -> bool

Returns true if the given selector is known to this type.

fn abi_decode_raw( selector: [u8; 4], data: &[u8], validate: bool, ) -> Result<Self>

ABI-decodes the given data into one of the variants of self.

fn abi_encoded_size(&self) -> usize

The size of the encoded data, without any selectors.

fn abi_encode_raw(&self, out: &mut Vec<u8>)

ABI-encodes self into the given buffer, without any selectors.

Provided Methods

fn type_check(selector: [u8; 4]) -> Result<()>

Returns an error if the given selector is not known to this type.

fn selectors() -> Selectors<Self>

Returns an iterator over the selectors of this type.

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

ABI-encodes self into the given buffer.

fn abi_decode(data: &[u8], validate: bool) -> Result<Self>

ABI-decodes the given data into one of the variants of self.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl SolInterface for Infallible

An empty SolInterface implementation. Used by GenericContractError.

const NAME: &'static str = "GenericContractError"

const MIN_DATA_LENGTH: usize = 18_446_744_073_709_551_615usize

const COUNT: usize = 0usize

fn selector(&self) -> [u8; 4]

fn selector_at(_i: usize) -> Option<[u8; 4]>

fn valid_selector(_selector: [u8; 4]) -> bool

fn abi_decode_raw( selector: [u8; 4], _data: &[u8], _validate: bool, ) -> Result<Self>

fn abi_encoded_size(&self) -> usize

fn abi_encode_raw(&self, _out: &mut Vec<u8>)

Implementors

impl<T: SolInterface> SolInterface for ContractError<T>

const NAME: &'static str = "ContractError"

const MIN_DATA_LENGTH: usize = _

const COUNT: usize = _