Struct forc_pkg::manifest::PackageManifestFile

pub struct PackageManifestFile { /* private fields */ }

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

Implementations

impl PackageManifestFile

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 invalid names, fields were used.

If core and std are unspecified, std will be added to the dependencies table implicitly. In this case, the git tag associated with the version of this crate is used to specify the pinned commit at which we fetch std.

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

Validate the PackageManifest.

This checks the project and organization names against a set of reserved/restricted keywords and patterns, and if a given entry point exists.

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 manfiest was loaded.

This will always be a canonical path.

pub fn entry_path(&self) -> PathBuf

Given the directory in which the file associated with this PackageManifest resides, produce the path to the entry file as specified in the manifest.

This will always be a canonical path.

pub fn entry_string(&self) -> Result<Arc<str>>

Produces the string of the entry point file.

pub fn program_type(&self) -> Result<TreeType>

Parse and return the associated project’s program type.

pub fn check_program_type(&self, expected_types: Vec<TreeType>) -> Result<()>

Given the current directory and expected program type, determines whether the correct program type is present.

pub fn build_profile(&self, profile_name: &str) -> Option<&BuildProfile>

Access the build profile associated with the given profile name.

pub fn dep_path(&self, dep_name: &str) -> Option<PathBuf>

Given the name of a path dependency, returns the full canonical Path to the dependency.

pub fn config_time_constants(&self) -> BTreeMap<String, ConfigTimeConstant>

Getter for the config time constants on the manifest.

pub fn workspace(&self) -> Result<Option<WorkspaceManifestFile>>

Returns the workspace manifest file if this PackageManifestFile is one of the members.

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

Returns the location of the lock file for PackageManifestFile. Checks if this PackageManifestFile corresponds to a workspace member and if that is the case returns the workspace level lock file’s location.

This will always be a canonical path.

Methods from Deref<Target = PackageManifest>

pub const DEFAULT_ENTRY_FILE_NAME: &'static str = "main.sw"

pub fn validate(&self) -> Result<()>

Validate the PackageManifest.

This checks the project and organization names against a set of reserved/restricted keywords and patterns.

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

Produce an iterator yielding all listed dependencies.

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

Produce an iterator yielding all listed build profiles.

pub fn contract_deps(
    &self
) -> impl Iterator<Item = (&String, &ContractDependency)>

Produce an iterator yielding all listed contract dependencies

pub fn deps_detailed(
    &self
) -> impl Iterator<Item = (&String, &DependencyDetails)>

Produce an iterator yielding all Detailed dependencies.

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

Produce an iterator yielding all listed patches.

pub fn dep(&self, dep_name: &str) -> Option<&Dependency>

Retrieve a reference to the dependency with the given name.

pub fn dep_detailed(&self, dep_name: &str) -> Option<&DependencyDetails>

Retrieve a reference to the dependency with the given name.

pub fn patch(&self, patch_name: &str) -> Option<&BTreeMap<String, Dependency>>

Retrieve the listed patches for the given name.

pub fn contract_dep(
    &self,
    contract_dep_name: &str
) -> Option<&ContractDependency>

Retrieve a reference to the contract dependency with the given name.

pub fn contract_dependency_detailed(
    &self,
    contract_dep_name: &str
) -> Option<&DependencyDetails>

Retrieve a reference to the contract dependency with the given name.

Trait Implementations

impl Clone for PackageManifestFile

fn clone(&self) -> PackageManifestFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageManifestFile

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

Formats the value using the given formatter.

impl Deref for PackageManifestFile

type Target = PackageManifest

The resulting type after dereferencing.

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

Dereferences the value.