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

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§

source§

impl OutputSelection

source

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.

source

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)

source

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)

source

pub fn empty_file_output_select() -> FileOutputSelection

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

Trait Implementations§

source§

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

source§

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

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

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

source§

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

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

impl Clone for OutputSelection

source§

fn clone(&self) -> OutputSelection

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for OutputSelection

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for OutputSelection

source§

fn default() -> OutputSelection

Returns the “default value” for a type. Read more
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

impl PartialEq for OutputSelection

source§

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

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

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.
source§

impl Serialize for OutputSelection

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for OutputSelection

source§

impl StructuralPartialEq for OutputSelection

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> JsonSchemaMaybe for T