Struct SolData

#[non_exhaustive]
pub struct SolData {
    pub license: Option<Spanned<String>>,
    pub version: Option<Spanned<String>>,
    pub experimental: Option<Spanned<String>>,
    pub imports: Vec<Spanned<SolImport>>,
    pub version_req: Option<VersionReq>,
    pub libraries: Vec<SolLibrary>,
    pub contract_names: Vec<String>,
    pub is_yul: bool,
    pub parse_result: Result<(), String>,
}

Represents various information about a Solidity file.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

license: Option<Spanned<String>>

version: Option<Spanned<String>>

experimental: Option<Spanned<String>>

imports: Vec<Spanned<SolImport>>

version_req: Option<VersionReq>

libraries: Vec<SolLibrary>

contract_names: Vec<String>

is_yul: bool

parse_result: Result<(), String>

Implementations

impl SolData

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

Returns the result of parsing the file.

pub fn fmt_version<W: Write>(&self, f: &mut W) -> Result<(), Error>

pub fn parse(content: &str, file: &Path) -> Self

Extracts the useful data from a solidity source

This will attempt to parse the solidity AST and extract the imports and version pragma. If parsing fails, we’ll fall back to extract that info via regex

pub fn parse_version_pragma(pragma: &str) -> Option<Result<VersionReq, Error>>

Parses the version pragma and returns the corresponding SemVer version requirement.

See parse_version_req.

pub fn parse_version_req(version: &str) -> Result<VersionReq, Error>

Returns the corresponding SemVer version requirement for the solidity version.

Note: This is a workaround for the fact that VersionReq::parse does not support whitespace separators and requires comma separated operators. See VersionReq.

Trait Implementations

impl Clone for SolData

fn clone(&self) -> SolData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SolData

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

Formats the value using the given formatter.

impl From<SolData> for MultiCompilerParsedSource

fn from(data: SolData) -> Self

Converts to this type from the input type.

impl ParsedSource for SolData

type Language = SolcLanguage

fn parse(content: &str, file: &Path) -> Result<Self>

Parses the content of the source file.

fn version_req(&self) -> Option<&VersionReq>

Returns the version requirement of the source.

fn contract_names(&self) -> &[String]

Returns a list of contract names defined in the source.

fn language(&self) -> Self::Language

Returns the language of the source.

fn resolve_imports<C>( &self, _paths: &ProjectPathsConfig<C>, _include_paths: &mut BTreeSet<PathBuf>, ) -> Result<Vec<PathBuf>>

Invoked during import resolution. Should resolve imports for the given source, and populate include_paths for compilers which support this config.

fn compilation_dependencies<'a>( &self, imported_nodes: impl Iterator<Item = (&'a Path, &'a Self)>, ) -> impl Iterator<Item = &'a Path>

where Self: 'a,

Used to configure OutputSelection for sparse builds. In certain cases, we might want to include some of the file dependencies into the compiler output even if we might not be directly interested in them.