Struct forc_pkg::manifest::Manifest

pub struct Manifest {
    pub project: Project,
    pub network: Option<Network>,
    pub dependencies: Option<BTreeMap<String, Dependency>>,
}

Fields

project: Project

network: Option<Network>

dependencies: Option<BTreeMap<String, Dependency>>

Implementations

impl Manifest

pub const DEFAULT_ENTRY_FILE_NAME: &'static str

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.

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

Validate the Manifest.

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 entry_path(&self, manifest_dir: &Path) -> PathBuf

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

pub fn entry_string(&self, manifest_dir: &Path) -> Result<Arc<str>>

Produces the string of the entry point file.

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

Produce an iterator yielding all listed dependencies.

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

Produce an iterator yielding all Detailed dependencies.

Trait Implementations

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.