Struct BuildPlan

pub struct BuildPlan { /* private fields */ }

Represents the full build plan for a project.

Implementations

impl BuildPlan

pub fn from_pkg_opts(pkg_options: &PkgOpts) -> Result<Self>

Create a new build plan for the project from the build options provided.

To do so, it tries to read the manifet file at the target path and creates the plan with BuildPlan::from_lock_and_manifest.

pub fn from_manifests( manifests: &MemberManifestFiles, offline: bool, ipfs_node: &IPFSNode, ) -> Result<Self>

Create a new build plan for the project by fetching and pinning all dependencies.

To account for an existing lock file, use from_lock_and_manifest instead.

pub fn from_lock_and_manifests( lock_path: &Path, manifests: &MemberManifestFiles, locked: bool, offline: bool, ipfs_node: &IPFSNode, ) -> Result<Self>

Create a new build plan taking into account the state of both the PackageManifest and the existing lock file if there is one.

This will first attempt to load a build plan from the lock file and validate the resulting graph using the current state of the PackageManifest.

This includes checking if the [dependencies] or [patch] tables have changed and checking the validity of the local path dependencies. If any changes are detected, the graph is updated and any new packages that require fetching are fetched.

The resulting build plan should always be in a valid state that is ready for building or checking.

pub fn contract_dependencies( &self, node: NodeIx, ) -> impl Iterator<Item = NodeIx> + '_

Produce an iterator yielding all contract dependencies of given node in the order of compilation.

pub fn member_nodes(&self) -> impl Iterator<Item = NodeIx> + '_

Produce an iterator yielding all workspace member nodes in order of compilation.

In the case that this BuildPlan was constructed for a single package, only that package’s node will be yielded.

pub fn member_pinned_pkgs(&self) -> impl Iterator<Item = Pinned> + '_

Produce an iterator yielding all workspace member pinned pkgs in order of compilation.

In the case that this BuildPlan was constructed for a single package, only that package’s pinned pkg will be yielded.

pub fn graph(&self) -> &Graph

View the build plan’s compilation graph.

pub fn manifest_map(&self) -> &ManifestMap

View the build plan’s map of pinned package IDs to their associated manifest.

pub fn compilation_order(&self) -> &[NodeIx]

The order in which nodes are compiled, determined via a toposort of the package graph.

pub fn find_member_index(&self, member_name: &str) -> Option<NodeIx>

Produce the node index of the member with the given name.

pub fn node_deps(&self, n: NodeIx) -> impl '_ + Iterator<Item = NodeIx>

Produce an iterator yielding indices for the given node and its dependencies in BFS order.

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

Produce an iterator yielding build profiles from the member nodes of this BuildPlan.

pub fn salt(&self, pinned: &Pinned) -> Option<Salt>

Returns a salt for the given pinned package if it is a contract and None for libraries.

pub fn visualize(&self, url_file_prefix: Option<String>) -> String

Returns a String representing the build dependency graph in GraphViz DOT format.

Trait Implementations

impl Clone for BuildPlan

fn clone(&self) -> BuildPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildPlan

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

Formats the value using the given formatter.