Struct forc_pkg::manifest::WorkspaceManifestFile

pub struct WorkspaceManifestFile { /* private fields */ }

A WorkspaceManifest that was deserialized from a file at a particular path.

Implementations

impl WorkspaceManifestFile

pub fn from_file(path: PathBuf) -> Result<Self>

Given a path to a Forc.toml, read it and construct a PackageManifest

This also validates the manifest, returning an Err in the case that given members are not present in the manifest dir.

pub fn from_dir(manifest_dir: &Path) -> Result<Self>

Read the manifest from the Forc.toml in the directory specified by the given path or any of its parent directories.

This is short for PackageManifest::from_file, but takes care of constructing the path to the file.

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

Returns an iterator over relative paths of workspace members.

pub fn member_paths(&self) -> Result<impl Iterator<Item = PathBuf> + '_>

Returns an iterator over workspace member root directories.

This will always return canonical paths.

pub fn member_pkg_manifests(
    &self
) -> Result<impl Iterator<Item = Result<PackageManifestFile>> + '_>

Returns an iterator over workspace member package manifests.

pub fn path(&self) -> &Path

The path to the Forc.toml from which this manifest was loaded.

This will always be a canonical path.

pub fn dir(&self) -> &Path

The path to the directory containing the Forc.toml from which this manifest was loaded.

This will always be a canonical path.

pub fn is_member_path(&self, path: &Path) -> Result<bool>

Check if given path corresponds to any workspace member’s path

pub fn lock_path(&self) -> PathBuf

Returns the location of the lock file for WorkspaceManifestFile.

This will always be a canonical path.

Methods from Deref<Target = WorkspaceManifest>

pub fn validate(&self, path: &Path) -> Result<()>

Validate the WorkspaceManifest

This checks if the listed members in the WorkspaceManifest are indeed in the given Forc.toml’s directory.

Trait Implementations

impl Clone for WorkspaceManifestFile

fn clone(&self) -> WorkspaceManifestFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceManifestFile

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

Formats the value using the given formatter.

impl Deref for WorkspaceManifestFile

type Target = WorkspaceManifest

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.