Struct Source

pub struct Source {
    pub content: Arc<String>,
}

Available on crate feature solc only.

Content of a solidity file

This contains the actual source code of a file

Fields

content: Arc<String>

Content of the file

This is an Arc because it may be cloned. If the Graph of the project contains multiple conflicting versions then the same Source may be required by conflicting versions and needs to be duplicated.

Implementations

impl Source

pub fn new(content: impl Into<String>) -> Source

Creates a new instance of Source with the given content.

pub fn read(file: impl AsRef<Path>) -> Result<Source, SolcIoError>

Reads the file’s content

pub fn read_all_from( dir: impl AsRef<Path>, ) -> Result<BTreeMap<PathBuf, Source>, SolcIoError>

Recursively finds all source files under the given dir path and reads them all

pub fn read_all_files( files: Vec<PathBuf>, ) -> Result<BTreeMap<PathBuf, Source>, SolcIoError>

Reads all source files of the given vec

Depending on the len of the vec it will try to read the files in parallel

pub fn read_all<T, I>( files: I, ) -> Result<BTreeMap<PathBuf, Source>, SolcIoError>

where I: IntoIterator<Item = T>, T: Into<PathBuf>,

Reads all files

pub fn par_read_all<T, I>( files: I, ) -> Result<BTreeMap<PathBuf, Source>, SolcIoError>

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: Send, T: Into<PathBuf> + Send,

Parallelized version of Self::read_all that reads all files using a parallel iterator

NOTE: this is only expected to be faster than Self::read_all if the given iterator contains at least several paths or the files are rather large.

pub fn content_hash(&self) -> String

Generate a non-cryptographically secure checksum of the file’s content

pub fn parse_imports(&self) -> Vec<&str>

Returns all import statements of the file

impl Source

pub async fn async_read(file: impl AsRef<Path>) -> Result<Source, SolcIoError>

Available on crate feature async only.

async version of Self::read

pub async fn async_read_all_from( dir: impl AsRef<Path>, ) -> Result<BTreeMap<PathBuf, Source>, SolcIoError>

Available on crate feature async only.

Finds all source files under the given dir path and reads them all

pub async fn async_read_all<T, I>( files: I, ) -> Result<BTreeMap<PathBuf, Source>, SolcIoError>

where I: IntoIterator<Item = T>, T: Into<PathBuf>,

Available on crate feature async only.

async version of Self::read_all

Trait Implementations

impl AsRef<[u8]> for Source

fn as_ref(&self) -> &[u8]

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

impl AsRef<str> for Source

fn as_ref(&self) -> &str

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

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Source

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Source

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Source

impl StructuralPartialEq for Source