Struct WorkspaceManifestFile

pub struct WorkspaceManifestFile { /* private fields */ }

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

Implementations

impl WorkspaceManifestFile

pub fn patches( &self, ) -> impl Iterator<Item = (&String, &BTreeMap<String, Dependency>)>

Produce an iterator yielding all listed patches.

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 is_member_path(&self, path: &Path) -> Result<bool>

Check if given path corresponds to any workspace member’s 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.

impl GenericManifestFile for WorkspaceManifestFile

fn from_file<P: AsRef<Path>>(path: P) -> 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.

fn from_dir<P: AsRef<Path>>(manifest_dir: P) -> 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.

fn lock_path(&self) -> Result<PathBuf>

Returns the location of the lock file for WorkspaceManifestFile.

This will always be a canonical path.

fn path(&self) -> &Path

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

fn member_manifests(&self) -> Result<MemberManifestFiles>

Returns a mapping of member member names to package manifest files.

fn dir(&self) -> &Path

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

impl TryInto<WorkspaceManifestFile> for ManifestFile

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<WorkspaceManifestFile>

Performs the conversion.