Struct wasmer_toml::Manifest

#[non_exhaustive]
pub struct Manifest {
    pub package: Option<Package>,
    pub dependencies: HashMap<String, VersionReq>,
    pub fs: IndexMap<String, PathBuf>,
    pub modules: Vec<Module>,
    pub commands: Vec<Command>,
}

The manifest represents the file used to describe a Wasm package.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

package: Option<Package>

Metadata about the package itself.

dependencies: HashMap<String, VersionReq>

The package’s dependencies.

fs: IndexMap<String, PathBuf>

The mappings used when making bundled assets available to WebAssembly instances, in the form guest -> host.

modules: Vec<Module>

WebAssembly modules to be published.

commands: Vec<Command>

Commands the package makes available to users.

Implementations

impl Manifest

pub fn builder(package: Package) -> ManifestBuilder

Create a ManifestBuilder populated with all mandatory fields.

pub fn parse(s: &str) -> Result<Self, Error>

Parse a Manifest from its TOML representation.

pub fn find_in_directory<T: AsRef<Path>>(path: T) -> Result<Self, ManifestError>

Construct a manifest by searching in the specified directory for a manifest file.

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

Validate this Manifest to check for common semantic errors.

Some common error cases are:

• Having multiple modules with the same name
• Having multiple commands with the same name
• A Command that references a non-existent Module in the current package
• A Package::entrypoint which points to a non-existent Command

pub fn add_dependency( &mut self, dependency_name: String, dependency_version: VersionReq )

add a dependency

pub fn remove_dependency(&mut self, dependency_name: &str) -> Option<VersionReq>

remove dependency by package name

pub fn to_string(&self) -> Result<String>

Convert a Manifest to its TOML representation.

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

Write the manifest to permanent storage

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.