Struct forc_pkg::BuildPlan

pub struct BuildPlan { /* private fields */ }

Represents the full build plan for a project.

Implementations

impl BuildPlan

pub fn new(
    manifest: &ManifestFile,
    sway_git_tag: &str,
    offline: bool
) -> Result<Self>

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

pub fn apply_pkg_diff(
    &self,
    pkg_diff: PkgDiff,
    sway_git_tag: &str,
    offline_mode: bool
) -> Result<Self>

Create a new build plan from an existing one. Needs the difference with the existing plan with the lock.

pub fn from_lock(
    proj_path: &Path,
    lock: &Lock,
    sway_git_tag: &str
) -> Result<Self>

Attempt to load the build plan from the Lock.

pub fn from_lock_file(lock_path: &Path, sway_git_tag: &str) -> Result<Self>

Attempt to load the build plan from the Forc.lock file.

pub fn validate(
    &self,
    manifest: &Manifest,
    sway_git_tag: &str
) -> Result<PkgDiff>

Ensure that the build plan is valid for the given manifest.

pub fn graph(&self) -> &Graph

View the build plan’s compilation graph.

pub fn path_map(&self) -> &PathMap

View the build plan’s map of pinned package IDs to the path containing a local copy of their source.

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

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

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.