Struct SolData

pub struct SolData {
    pub license: Option<SolDataUnit<String>>,
    pub version: Option<SolDataUnit<String>>,
    pub experimental: Option<SolDataUnit<String>>,
    pub imports: Vec<SolDataUnit<SolImport>>,
    pub version_req: Option<VersionReq>,
    pub libraries: Vec<SolLibrary>,
    pub is_yul: bool,
}

Represents various information about a solidity file parsed via solang_parser

Fields

license: Option<SolDataUnit<String>>

version: Option<SolDataUnit<String>>

experimental: Option<SolDataUnit<String>>

imports: Vec<SolDataUnit<SolImport>>

version_req: Option<VersionReq>

libraries: Vec<SolLibrary>

is_yul: bool

Implementations

impl SolData

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_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 copy 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 ParsedSource for SolData

type Language = SolcLanguage

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

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

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 language(&self) -> Self::Language

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.