Enum CallerMode

#[repr(u8)]
pub enum CallerMode {
    None,
    Broadcast,
    RecurrentBroadcast,
    Prank,
    RecurrentPrank,
    // some variants omitted
}

A modification applied to either msg.sender or tx.origin. Returned by readCallers.

enum CallerMode { None, Broadcast, RecurrentBroadcast, Prank, RecurrentPrank }

Variants

None

No caller modification is currently active.

Broadcast

A one time broadcast triggered by a vm.broadcast() call is currently active.

RecurrentBroadcast

A recurrent broadcast triggered by a vm.startBroadcast() call is currently active.

Prank

A one time prank triggered by a vm.prank() call is currently active.

RecurrentPrank

A recurrent prank triggered by a vm.startPrank() call is currently active.

Implementations

impl CallerMode

pub const ENUM: &'static Enum<'static> = _

The enum definition.

Trait Implementations

impl Clone for CallerMode

fn clone(&self) -> CallerMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallerMode

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

Formats the value using the given formatter.

impl EventTopic for CallerMode

fn topic_preimage_length(rust: &<CallerMode as SolType>::RustType) -> usize

The number of bytes this type occupies in another topic’s preimage, usually a multiple of 32.

fn encode_topic_preimage( rust: &<CallerMode as SolType>::RustType, out: &mut Vec<u8>, )

Encodes this type as preimage bytes which are then hashed in complex types’ [encode_topic][EventTopic::encode_topic].

fn encode_topic(rust: &<CallerMode as SolType>::RustType) -> WordToken

Indexed event parameter encoding.

impl From<CallerMode> for u8

fn from(v: CallerMode) -> u8

Converts to this type from the input type.

impl SolEnum for CallerMode

const COUNT: usize = 5usize

The number of variants in the enum.

fn tokenize(self) -> WordToken

Tokenize the enum.

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

ABI decode the enum from the given buffer.

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

ABI encode the enum into the given buffer.

fn abi_encode(self) -> Vec<u8>

ABI encode the enum.

impl SolType for CallerMode

const SOL_NAME: &'static str = <alloy_sol_types::sol_data::Uint<8> as alloy_sol_types::SolType>::SOL_NAME

The name of this type in Solidity.

const ENCODED_SIZE: Option<usize> = <alloy_sol_types::sol_data::Uint<8> as alloy_sol_types::SolType>::ENCODED_SIZE

The statically-known ABI-encoded size of the type.

const PACKED_ENCODED_SIZE: Option<usize> = <alloy_sol_types::sol_data::Uint<8> as alloy_sol_types::SolType>::PACKED_ENCODED_SIZE

The statically-known Non-standard Packed Mode ABI-encoded size of the type.

type RustType = CallerMode

The corresponding Rust type.

type Token<'a> = <Uint<8> as SolType>::Token<'a>

The corresponding ABI token type.

fn valid_token(token: &<CallerMode as SolType>::Token<'_>) -> bool

Returns true if the given token can be detokenized with this type.

fn type_check(token: &<CallerMode as SolType>::Token<'_>) -> Result<(), Error>

Returns an error if the given token cannot be detokenized with this type.

fn detokenize( token: <CallerMode as SolType>::Token<'_>, ) -> <CallerMode as SolType>::RustType

Detokenize this type’s value from the given token.

const DYNAMIC: bool = _

Whether the ABI-encoded size is dynamic.

fn sol_type_name() -> Cow<'static, str>

👎Deprecated since 0.6.3: use SOL_NAME instead

Returns the name of this type in Solidity.

fn abi_encoded_size<E>(rust: &E) -> usize

where E: SolTypeValue<Self> + ?Sized,

Calculate the ABI-encoded size of the data, counting both head and tail words. For a single-word type this will always be 32.

fn tokenize<E>(rust: &E) -> Self::Token<'_>

where E: SolTypeValue<Self> + ?Sized,

Tokenizes the given value into this type’s token.

fn eip712_data_word<E>(rust: &E) -> FixedBytes<32>

where E: SolTypeValue<Self> + ?Sized,

Encode this data according to EIP-712 encodeData rules, and hash it if necessary.

fn abi_packed_encoded_size<E>(rust: &E) -> usize

where E: SolTypeValue<Self> + ?Sized,

Returns the length of this value when ABI-encoded in Non-standard Packed Mode.

fn abi_encode_packed_to<E>(rust: &E, out: &mut Vec<u8>)

where E: SolTypeValue<Self> + ?Sized,

Non-standard Packed Mode ABI encoding.

fn abi_encode_packed<E>(rust: &E) -> Vec<u8>

where E: SolTypeValue<Self> + ?Sized,

Non-standard Packed Mode ABI encoding.

fn abi_encode<E>(rust: &E) -> Vec<u8>

where E: SolTypeValue<Self> + ?Sized,

Tokenizes and ABI-encodes the given value by wrapping it in a single-element sequence.

fn abi_encode_params<E>(rust: &E) -> Vec<u8>

where E: SolTypeValue<Self> + ?Sized, Self::Token<'a>: for<'a> TokenSeq<'a>,

Tokenizes and ABI-encodes the given value as function parameters.

fn abi_encode_sequence<E>(rust: &E) -> Vec<u8>

where E: SolTypeValue<Self> + ?Sized, Self::Token<'a>: for<'a> TokenSeq<'a>,

Tokenizes and ABI-encodes the given value as a sequence.

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

Decodes this type’s value from an ABI blob by interpreting it as a single-element sequence.

fn abi_decode_params<'de>( data: &'de [u8], validate: bool, ) -> Result<Self::RustType, Error>

where Self::Token<'de>: TokenSeq<'de>,

Decodes this type’s value from an ABI blob by interpreting it as function parameters.

fn abi_decode_sequence<'de>( data: &'de [u8], validate: bool, ) -> Result<Self::RustType, Error>

where Self::Token<'de>: TokenSeq<'de>,

Decodes this type’s value from an ABI blob by interpreting it as a sequence.

impl SolValue for CallerMode

type SolType = CallerMode

The Solidity type that this type corresponds to.

fn sol_name(&self) -> &'static str

The name of the associated Solidity type.

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

The name of the associated Solidity type.

fn tokenize(&self) -> <Self::SolType as SolType>::Token<'_>

Tokenizes the given value into this type’s token.

fn detokenize(token: <Self::SolType as SolType>::Token<'_>) -> Self

where Self: From<<Self::SolType as SolType>::RustType>,

Detokenize a value from the given token.

fn abi_encoded_size(&self) -> usize

Calculate the ABI-encoded size of the data.

fn eip712_data_word(&self) -> FixedBytes<32>

Encode this data according to EIP-712 encodeData rules, and hash it if necessary.

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

Non-standard Packed Mode ABI encoding.

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

Non-standard Packed Mode ABI encoding.

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

ABI-encodes the value.

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

where <Self::SolType as SolType>::Token<'a>: for<'a> TokenSeq<'a>,

Encodes an ABI sequence.

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

where <Self::SolType as SolType>::Token<'a>: for<'a> TokenSeq<'a>,

Encodes an ABI sequence suitable for function parameters.

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

where Self: From<<Self::SolType as SolType>::RustType>,

ABI-decode this type from the given data.

fn abi_decode_params<'de>( data: &'de [u8], validate: bool, ) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>, <Self::SolType as SolType>::Token<'de>: TokenSeq<'de>,

ABI-decode this type from the given data.

fn abi_decode_sequence<'de>( data: &'de [u8], validate: bool, ) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>, <Self::SolType as SolType>::Token<'de>: TokenSeq<'de>,

ABI-decode this type from the given data.

impl TryFrom<u8> for CallerMode

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: u8) -> Result<CallerMode, Error>

Performs the conversion.

impl Copy for CallerMode

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

• None: 0 bytes
• Broadcast: 0 bytes
• RecurrentBroadcast: 0 bytes
• Prank: 0 bytes
• RecurrentPrank: 0 bytes
• __Invalid: 0 bytes