Enum Group

#[non_exhaustive]
pub enum Group {
    Evm,
    Testing,
    Scripting,
    Filesystem,
    Environment,
    String,
    Json,
    Toml,
    Crypto,
    Utilities,
}

Cheatcode groups. Initially derived and modified from inline comments in forge-std’s Vm.sol.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Evm

Cheatcodes that read from, or write to the current EVM execution state.

Examples: any of the record cheatcodes, chainId, coinbase.

Safety: ambiguous, depends on whether the cheatcode is read-only or not.

Testing

Cheatcodes that interact with how a test is run.

Examples: assume, skip, expectRevert.

Safety: ambiguous, depends on whether the cheatcode is read-only or not.

Scripting

Cheatcodes that interact with how a script is run.

Examples: broadcast, startBroadcast, stopBroadcast.

Safety: safe.

Filesystem

Cheatcodes that interact with the OS or filesystem.

Examples: ffi, projectRoot, writeFile.

Safety: safe.

Environment

Cheatcodes that interact with the program’s environment variables.

Examples: setEnv, envBool, envOr.

Safety: safe.

String

Utility cheatcodes that deal with string parsing and manipulation.

Examples: toString. parseBytes.

Safety: safe.

Json

Utility cheatcodes that deal with parsing values from and converting values to JSON.

Examples: serializeJson, parseJsonUint, writeJson.

Safety: safe.

Toml

Utility cheatcodes that deal with parsing values from and converting values to TOML.

Examples: parseToml, writeToml.

Safety: safe.

Crypto

Cryptography-related cheatcodes.

Examples: sign*.

Safety: safe.

Utilities

Generic, uncategorized utilities.

Examples: toString, parse*, serialize*.

Safety: safe.

Implementations

impl Group

pub const fn safety(self) -> Option<Safety>

Returns the safety of this cheatcode group.

Some groups are inherently safe or unsafe, while others are ambiguous and will return None.

pub const fn as_str(self) -> &'static str

Returns this value as a string.

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Group

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Group

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Group

fn schema_name() -> String

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for Group

fn cmp(&self, other: &Group) -> 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 PartialEq for Group

fn eq(&self, other: &Group) -> 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 PartialOrd for Group

fn partial_cmp(&self, other: &Group) -> 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 Serialize for Group

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Group

impl Eq for Group

impl StructuralPartialEq for Group

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:

• Evm: 0 bytes
• Testing: 0 bytes
• Scripting: 0 bytes
• Filesystem: 0 bytes
• Environment: 0 bytes
• String: 0 bytes
• Json: 0 bytes
• Toml: 0 bytes
• Crypto: 0 bytes
• Utilities: 0 bytes