Struct ethers_solc::Artifacts

source ·
pub struct Artifacts<T>(pub FileToContractsMap<Vec<ArtifactFile<T>>>);
Expand description

Represents a set of Artifacts

Tuple Fields§

§0: FileToContractsMap<Vec<ArtifactFile<T>>>

Implementations§

source§

impl<T: Serialize> Artifacts<T>

source

pub fn write_all(&self) -> Result<()>

Writes all artifacts into the given artifacts_root folder

source§

impl<T> Artifacts<T>

source

pub fn slash_paths(&mut self)

Converts all \\ separators in all paths to /

source

pub fn into_inner(self) -> FileToContractsMap<Vec<ArtifactFile<T>>>

source

pub fn join_all(&mut self, root: impl AsRef<Path>) -> &mut Self

Sets the artifact files location to root adjoined to self.file.

source

pub fn strip_prefix_all(&mut self, base: impl AsRef<Path>) -> &mut Self

Removes base from all artifacts

source

pub fn find_artifact( &self, file: &str, contract_name: &str, version: &Version ) -> Option<&ArtifactFile<T>>

Returns the Artifact with matching file, contract name and version

source

pub fn has_contract_artifact( &self, contract_name: &str, artifact_path: &Path ) -> bool

Returns true if this type contains an artifact with the given path for the given contract

source

pub fn has_artifact(&self, artifact_path: &Path) -> bool

Returns true if this type contains an artifact with the given path

source

pub fn artifact_files(&self) -> impl Iterator<Item = &ArtifactFile<T>>

Iterate over all artifact files

source

pub fn artifact_files_mut( &mut self ) -> impl Iterator<Item = &mut ArtifactFile<T>>

Iterate over all artifact files

source

pub fn artifacts<O: ArtifactOutput<Artifact = T>>( &self ) -> impl Iterator<Item = (ArtifactId, &T)> + '_

Returns an iterator over all artifacts and <file name:contract name>.

Borrowed version of Self::into_artifacts.

source

pub fn into_artifacts<O: ArtifactOutput<Artifact = T>>( self ) -> impl Iterator<Item = (ArtifactId, T)>

Returns an iterator over all artifacts and <file name:contract name>

source

pub fn artifacts_with_files( &self ) -> impl Iterator<Item = (&String, &String, &T)> + '_

Returns an iterator that yields the tuple (file, contract name, artifact)

NOTE this returns the path as is

Borrowed version of Self::into_artifacts_with_files.

source

pub fn into_artifacts_with_files( self ) -> impl Iterator<Item = (String, String, T)>

Returns an iterator that yields the tuple (file, contract name, artifact)

NOTE this returns the path as is

source

pub fn into_stripped_file_prefixes(self, base: impl AsRef<Path>) -> Self

Strips the given prefix from all artifact file paths to make them relative to the given root argument

source

pub fn find_first(&self, contract_name: impl AsRef<str>) -> Option<&T>

Finds the first artifact T with a matching contract name

source

pub fn find( &self, path: impl AsRef<str>, contract: impl AsRef<str> ) -> Option<&T>

Finds the artifact with matching path and name

source

pub fn remove( &mut self, path: impl AsRef<str>, contract: impl AsRef<str> ) -> Option<T>

Removes the artifact with matching file and name

source

pub fn remove_first(&mut self, contract_name: impl AsRef<str>) -> Option<T>

Removes the first artifact T with a matching contract name

Note: if there are multiple artifacts (contract compiled with different solc) then this returns the first artifact in that set

Methods from Deref<Target = FileToContractsMap<Vec<ArtifactFile<T>>>>§

1.0.0 · source

pub fn get<Q>(&self, key: &Q) -> Option<&V>
where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

§Examples
use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.get(&1), Some(&"a"));
assert_eq!(map.get(&2), None);
1.40.0 · source

pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>
where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

Returns the key-value pair corresponding to the supplied key.

The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

§Examples
use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.get_key_value(&1), Some((&1, &"a")));
assert_eq!(map.get_key_value(&2), None);
1.66.0 · source

pub fn first_key_value(&self) -> Option<(&K, &V)>
where K: Ord,

Returns the first key-value pair in the map. The key in this pair is the minimum key in the map.

§Examples
use std::collections::BTreeMap;

let mut map = BTreeMap::new();
assert_eq!(map.first_key_value(), None);
map.insert(1, "b");
map.insert(2, "a");
assert_eq!(map.first_key_value(), Some((&1, &"b")));
1.66.0 · source

pub fn last_key_value(&self) -> Option<(&K, &V)>
where K: Ord,

Returns the last key-value pair in the map. The key in this pair is the maximum key in the map.

§Examples
use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(1, "b");
map.insert(2, "a");
assert_eq!(map.last_key_value(), Some((&2, &"a")));
1.0.0 · source

pub fn contains_key<Q>(&self, key: &Q) -> bool
where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

§Examples
use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(1, "a");
assert_eq!(map.contains_key(&1), true);
assert_eq!(map.contains_key(&2), false);
1.17.0 · source

pub fn range<T, R>(&self, range: R) -> Range<'_, K, V>
where T: Ord + ?Sized, K: Borrow<T> + Ord, R: RangeBounds<T>,

Constructs a double-ended iterator over a sub-range of elements in the map. The simplest way is to use the range syntax min..max, thus range(min..max) will yield elements from min (inclusive) to max (exclusive). The range may also be entered as (Bound<T>, Bound<T>), so for example range((Excluded(4), Included(10))) will yield a left-exclusive, right-inclusive range from 4 to 10.

§Panics

Panics if range start > end. Panics if range start == end and both bounds are Excluded.

§Examples
use std::collections::BTreeMap;
use std::ops::Bound::Included;

let mut map = BTreeMap::new();
map.insert(3, "a");
map.insert(5, "b");
map.insert(8, "c");
for (&key, &value) in map.range((Included(&4), Included(&8))) {
    println!("{key}: {value}");
}
assert_eq!(Some((&5, &"b")), map.range(4..).next());
1.0.0 · source

pub fn iter(&self) -> Iter<'_, K, V>

Gets an iterator over the entries of the map, sorted by key.

§Examples
use std::collections::BTreeMap;

let mut map = BTreeMap::new();
map.insert(3, "c");
map.insert(2, "b");
map.insert(1, "a");

for (key, value) in map.iter() {
    println!("{key}: {value}");
}

let (first_key, first_value) = map.iter().next().unwrap();
assert_eq!((*first_key, *first_value), (1, "a"));
1.0.0 · source

pub fn keys(&self) -> Keys<'_, K, V>

Gets an iterator over the keys of the map, in sorted order.

§Examples
use std::collections::BTreeMap;

let mut a = BTreeMap::new();
a.insert(2, "b");
a.insert(1, "a");

let keys: Vec<_> = a.keys().cloned().collect();
assert_eq!(keys, [1, 2]);
1.0.0 · source

pub fn values(&self) -> Values<'_, K, V>

Gets an iterator over the values of the map, in order by key.

§Examples
use std::collections::BTreeMap;

let mut a = BTreeMap::new();
a.insert(1, "hello");
a.insert(2, "goodbye");

let values: Vec<&str> = a.values().cloned().collect();
assert_eq!(values, ["hello", "goodbye"]);
1.0.0 · source

pub fn len(&self) -> usize

Returns the number of elements in the map.

§Examples
use std::collections::BTreeMap;

let mut a = BTreeMap::new();
assert_eq!(a.len(), 0);
a.insert(1, "a");
assert_eq!(a.len(), 1);
1.0.0 · source

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

§Examples
use std::collections::BTreeMap;

let mut a = BTreeMap::new();
assert!(a.is_empty());
a.insert(1, "a");
assert!(!a.is_empty());
source

pub fn lower_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, K, V>
where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

🔬This is a nightly-only experimental API. (btree_cursors)

Returns a Cursor pointing at the gap before the smallest key greater than the given bound.

Passing Bound::Included(x) will return a cursor pointing to the gap before the smallest key greater than or equal to x.

Passing Bound::Excluded(x) will return a cursor pointing to the gap before the smallest key greater than x.

Passing Bound::Unbounded will return a cursor pointing to the gap before the smallest key in the map.

§Examples
#![feature(btree_cursors)]

use std::collections::BTreeMap;
use std::ops::Bound;

let map = BTreeMap::from([
    (1, "a"),
    (2, "b"),
    (3, "c"),
    (4, "d"),
]);

let cursor = map.lower_bound(Bound::Included(&2));
assert_eq!(cursor.peek_prev(), Some((&1, &"a")));
assert_eq!(cursor.peek_next(), Some((&2, &"b")));

let cursor = map.lower_bound(Bound::Excluded(&2));
assert_eq!(cursor.peek_prev(), Some((&2, &"b")));
assert_eq!(cursor.peek_next(), Some((&3, &"c")));

let cursor = map.lower_bound(Bound::Unbounded);
assert_eq!(cursor.peek_prev(), None);
assert_eq!(cursor.peek_next(), Some((&1, &"a")));
source

pub fn upper_bound<Q>(&self, bound: Bound<&Q>) -> Cursor<'_, K, V>
where K: Borrow<Q> + Ord, Q: Ord + ?Sized,

🔬This is a nightly-only experimental API. (btree_cursors)

Returns a Cursor pointing at the gap after the greatest key smaller than the given bound.

Passing Bound::Included(x) will return a cursor pointing to the gap after the greatest key smaller than or equal to x.

Passing Bound::Excluded(x) will return a cursor pointing to the gap after the greatest key smaller than x.

Passing Bound::Unbounded will return a cursor pointing to the gap after the greatest key in the map.

§Examples
#![feature(btree_cursors)]

use std::collections::BTreeMap;
use std::ops::Bound;

let map = BTreeMap::from([
    (1, "a"),
    (2, "b"),
    (3, "c"),
    (4, "d"),
]);

let cursor = map.upper_bound(Bound::Included(&3));
assert_eq!(cursor.peek_prev(), Some((&3, &"c")));
assert_eq!(cursor.peek_next(), Some((&4, &"d")));

let cursor = map.upper_bound(Bound::Excluded(&3));
assert_eq!(cursor.peek_prev(), Some((&2, &"b")));
assert_eq!(cursor.peek_next(), Some((&3, &"c")));

let cursor = map.upper_bound(Bound::Unbounded);
assert_eq!(cursor.peek_prev(), Some((&4, &"d")));
assert_eq!(cursor.peek_next(), None);

Trait Implementations§

source§

impl<T> AsMut<BTreeMap<String, BTreeMap<String, Vec<ArtifactFile<T>>>>> for Artifacts<T>

source§

fn as_mut(&mut self) -> &mut FileToContractsMap<Vec<ArtifactFile<T>>>

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

impl<T> AsRef<BTreeMap<String, BTreeMap<String, Vec<ArtifactFile<T>>>>> for Artifacts<T>

source§

fn as_ref(&self) -> &FileToContractsMap<Vec<ArtifactFile<T>>>

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

impl<T: Clone> Clone for Artifacts<T>

source§

fn clone(&self) -> Artifacts<T>

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<T: Debug> Debug for Artifacts<T>

source§

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

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

impl<T> Default for Artifacts<T>

source§

fn default() -> Self

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

impl<T> Deref for Artifacts<T>

§

type Target = BTreeMap<String, BTreeMap<String, Vec<ArtifactFile<T>>>>

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<T> From<BTreeMap<String, BTreeMap<String, Vec<ArtifactFile<T>>>>> for Artifacts<T>

source§

fn from(m: FileToContractsMap<Vec<ArtifactFile<T>>>) -> Self

Converts to this type from the input type.
source§

impl<'a, T> IntoIterator for &'a Artifacts<T>

§

type Item = (&'a String, &'a BTreeMap<String, Vec<ArtifactFile<T>>>)

The type of the elements being iterated over.
§

type IntoIter = Iter<'a, String, BTreeMap<String, Vec<ArtifactFile<T>>>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<T> IntoIterator for Artifacts<T>

§

type Item = (String, BTreeMap<String, Vec<ArtifactFile<T>>>)

The type of the elements being iterated over.
§

type IntoIter = IntoIter<String, BTreeMap<String, Vec<ArtifactFile<T>>>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<T: PartialEq> PartialEq for Artifacts<T>

source§

fn eq(&self, other: &Artifacts<T>) -> 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<T: Eq> Eq for Artifacts<T>

source§

impl<T> StructuralPartialEq for Artifacts<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for Artifacts<T>
where T: RefUnwindSafe,

§

impl<T> Send for Artifacts<T>
where T: Send,

§

impl<T> Sync for Artifacts<T>
where T: Sync,

§

impl<T> Unpin for Artifacts<T>

§

impl<T> UnwindSafe for Artifacts<T>
where T: RefUnwindSafe,

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> JsonSchemaMaybe for T