Struct ethers_solc::artifacts::output_selection::OutputSelection

pub struct OutputSelection(pub BTreeMap<String, FileOutputSelection>);

Represents the selected output of files and contracts The first level key is the file name and the second level key is the contract name. An empty contract name is used for outputs that are not tied to a contract but to the whole source file like the AST. A star as contract name refers to all contracts in the file. Similarly, a star as a file name matches all files. To select all outputs the compiler can possibly generate, use “outputSelection: { “”: { “”: [ “” ], “”: [ “” ] } }“ but note that this might slow down the compilation process needlessly.

The available output types are as follows:

File level (needs empty string as contract name): ast - AST of all source files

Contract level (needs the contract name or “”): abi - ABI devdoc - Developer documentation (natspec) userdoc - User documentation (natspec) metadata - Metadata ir - Yul intermediate representation of the code before optimization irOptimized - Intermediate representation after optimization storageLayout - Slots, offsets and types of the contract’s state variables. evm.assembly - New assembly format evm.legacyAssembly - Old-style assembly format in JSON evm.bytecode.functionDebugData - Debugging information at function level evm.bytecode.object - Bytecode object evm.bytecode.opcodes - Opcodes list evm.bytecode.sourceMap - Source mapping (useful for debugging) evm.bytecode.linkReferences - Link references (if unlinked object) evm.bytecode.generatedSources - Sources generated by the compiler evm.deployedBytecode - Deployed bytecode (has all the options that evm.bytecode has) evm.deployedBytecode.immutableReferences - Map from AST ids to bytecode ranges that reference immutables evm.methodIdentifiers - The list of function hashes evm.gasEstimates - Function gas estimates ewasm.wast - Ewasm in WebAssembly S-expressions format ewasm.wasm - Ewasm in WebAssembly binary format

Note that using a using evm, evm.bytecode, ewasm, etc. will select every target part of that output. Additionally, * can be used as a wildcard to request everything.

The default output selection is

  {
   "*": {
     "*": [
       "abi",
       "evm.bytecode",
       "evm.deployedBytecode",
       "evm.methodIdentifiers"
     ],
     "": [
       "ast"
     ]
   }
 }

Tuple Fields

0: BTreeMap<String, FileOutputSelection>

Implementations

impl OutputSelection

pub fn complete_output_selection() -> Self

select all outputs the compiler can possibly generate, use { "*": { "*": [ "*" ], "": [ "*" ] } } but note that this might slow down the compilation process needlessly.

pub fn default_output_selection() -> Self

Default output selection for compiler output:

{ "*": { "*": [ "*" ], "": [ "abi","evm.bytecode","evm.deployedBytecode","evm.methodIdentifiers"] } }

Which enables it for all files and all their contracts (“*” wildcard)

pub fn default_file_output_selection() -> FileOutputSelection

Default output selection for a single file:

{ "*": [ "*" ], "": [ "abi","evm.bytecode","evm.deployedBytecode","evm.methodIdentifiers"] }

Which enables it for all the contracts in the file (“*” wildcard)

pub fn empty_file_output_select() -> FileOutputSelection

Returns an empty output selection which corresponds to an empty map {}

Trait Implementations

impl AsMut<BTreeMap<String, BTreeMap<String, Vec<String>>>> for OutputSelection

fn as_mut(&mut self) -> &mut BTreeMap<String, FileOutputSelection>

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

impl AsRef<BTreeMap<String, BTreeMap<String, Vec<String>>>> for OutputSelection

fn as_ref(&self) -> &BTreeMap<String, FileOutputSelection>

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

impl Clone for OutputSelection

fn clone(&self) -> OutputSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OutputSelection

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

Formats the value using the given formatter.

impl Default for OutputSelection

fn default() -> OutputSelection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OutputSelection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BTreeMap<String, BTreeMap<String, Vec<String>>>> for OutputSelection

fn from(s: BTreeMap<String, FileOutputSelection>) -> Self

Converts to this type from the input type.

impl PartialEq for OutputSelection

fn eq(&self, other: &OutputSelection) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for OutputSelection

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OutputSelection

impl StructuralPartialEq for OutputSelection