Struct ethcontract_generate::Artifact

pub struct Artifact { /* fields omitted */ }

An entity that contains compiled contracts.

Implementations

impl Artifact

pub fn new() -> Artifact

Creates a new empty artifact.

pub fn with_origin(origin: impl Into<String>) -> Artifact

Creates a new artifact with an origin information.

pub fn origin(&self) -> &str

Provides description of where this artifact comes from.

This function is used when a human-readable reference to the artifact is required. It could be anything: path to a json file, url, etc.

pub fn set_origin(&mut self, origin: impl Into<String>)

Sets new origin for the artifact.

Artifact loaders will set origin to something meaningful in most cases, so this function should not be used often. There are cases when it is required, though.

pub fn len(&self) -> usize

Gets number of contracts contained in this artifact.

pub fn is_empty(&self) -> bool

Returns true if this artifact contains no contracts.

pub fn contains(&self, name: &str) -> bool

Returns true if this artifact has a contract with the given name.

pub fn get(&self, name: &str) -> Option<&Contract>

Looks up contract by its name and returns a reference to it.

Some artifact formats allow exporting a single unnamed contract. In this case, the contract will have an empty string as its name.

pub fn get_mut(&mut self, name: &str) -> Option<ContractMut<'_>>

Looks up contract by its name and returns a handle that allows safely mutating it.

The returned handle does not allow renaming contract. For that, you’ll need to remove it and add again.

pub fn insert(&mut self, contract: Contract) -> InsertResult<'_>

Inserts a new contract to the artifact.

If contract with this name already exists, replaces it and returns the old contract.

pub fn remove(&mut self, name: &str) -> Option<Contract>

Removes contract from the artifact.

Returns removed contract or None if contract with the given name wasn’t found.

pub fn iter(&self) -> impl Iterator<Item = &Contract>

Creates an iterator that yields the artifact’s contracts.

pub fn drain(&mut self) -> impl Iterator<Item = Contract>

Takes all contracts from the artifact, leaving it empty, and returns an iterator over the taken contracts.

Trait Implementations

impl Default for Artifact

pub fn default() -> Artifact

Returns the “default value” for a type.