Struct forc_pkg::manifest::Manifest

pub struct Manifest {
    pub project: Project,
    pub network: Option<Network>,
    pub dependencies: Option<BTreeMap<String, Dependency>>,
    pub patch: Option<BTreeMap<String, BTreeMap<String, Dependency>>>,
    pub constants: Option<BTreeMap<String, ConfigTimeConstant>>,
    /* private fields */
}

A direct mapping to a Forc.toml.

Fields

project: Project

network: Option<Network>

dependencies: Option<BTreeMap<String, Dependency>>

patch: Option<BTreeMap<String, BTreeMap<String, Dependency>>>

constants: Option<BTreeMap<String, ConfigTimeConstant>>

A list of configuration-time constants.

Implementations

impl Manifest

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

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

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

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 validate(&self) -> Result<()>

Validate the Manifest.

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

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

Given a directory to a forc project containing a Forc.toml, read the manifest.

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

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 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.

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Manifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Manifest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Manifest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.