Struct Graph

pub struct Graph<P: SourceParser = SolParser> {
    pub nodes: Vec<Node<P::ParsedSource>>,
    /* private fields */
}

Represents a fully-resolved solidity dependency graph.

Each node in the graph is a file and edges represent dependencies between them.

See also https://docs.soliditylang.org/en/latest/layout-of-source-files.html?highlight=import#importing-other-source-files

Fields

nodes: Vec<Node<P::ParsedSource>>

all nodes in the project, a Node represents a single file

Implementations

impl<P: SourceParser> Graph<P>

pub fn parser(&self) -> &P

Returns the parser used to parse the sources.

pub fn print(&self)

Print the graph to StdOut

pub fn print_with_options(&self, opts: TreeOptions)

Print the graph to StdOut using the provided TreeOptions

pub fn imported_nodes(&self, from: usize) -> &[usize]

Returns a list of nodes the given node index points to for the given kind.

pub fn all_imported_nodes( &self, from: usize, ) -> impl Iterator<Item = usize> + '_

Returns an iterator that yields all imports of a node and all their imports

pub fn files(&self) -> &HashMap<PathBuf, usize>

Returns all the resolved files and their index in the graph.

pub fn is_empty(&self) -> bool

Returns true if the graph is empty.

pub fn node(&self, index: usize) -> &Node<P::ParsedSource>

Gets a node by index.

Panics

if the index node id is not included in the graph

pub fn node_ids(&self, start: usize) -> impl Iterator<Item = usize> + '_

Returns an iterator that yields all nodes of the dependency tree that the given node id spans, starting with the node itself.

Panics

if the start node id is not included in the graph

pub fn nodes( &self, start: usize, ) -> impl Iterator<Item = &Node<P::ParsedSource>> + '_

Same as Self::node_ids but returns the actual Node

pub fn into_sources(self) -> (Sources, GraphEdges<P>)

Consumes the Graph, effectively splitting the nodes and the GraphEdges off and returning the nodes converted to Sources

pub fn input_nodes(&self) -> impl Iterator<Item = &Node<P::ParsedSource>>

Returns an iterator that yields only those nodes that represent input files. See Self::resolve_sources This won’t yield any resolved library nodes

pub fn imports(&self, path: &Path) -> HashSet<&Path>

Returns all files imported by the given file

pub fn resolve_sources( paths: &ProjectPathsConfig<<P::ParsedSource as ParsedSource>::Language>, sources: Sources, ) -> Result<Self>

Resolves a number of sources within the given config

pub fn resolve( paths: &ProjectPathsConfig<<P::ParsedSource as ParsedSource>::Language>, ) -> Result<Self>

Resolves the dependencies of a project’s source contracts

pub fn into_sources_by_version<C, T>( self, project: &Project<C, T>, ) -> Result<ResolvedSources<'_, C>>

where T: ArtifactOutput<CompilerContract = C::CompilerContract>, C: Compiler<Parser = P, Language = <P::ParsedSource as ParsedSource>::Language>,

Consumes the nodes of the graph and returns all input files together with their appropriate version and the edges of the graph

First we determine the compatible version for each input file (from sources and test folder, see Self::resolve) and then we add all resolved library imports.

Trait Implementations

impl<P: Debug + SourceParser> Debug for Graph<P>

where P::ParsedSource: Debug,

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

Formats the value using the given formatter.