Struct AddMetadata

#[non_exhaustive]
pub struct AddMetadata {
    pub name: Option<String>,
    pub language: Vec<(String, String)>,
    pub processed_by: Vec<(String, String)>,
    pub sdk: Vec<(String, String)>,
    pub authors: Option<Authors>,
    pub description: Option<Description>,
    pub licenses: Option<Licenses>,
    pub source: Option<Source>,
    pub homepage: Option<Homepage>,
    pub revision: Option<Revision>,
    pub version: Option<Version>,
}

Add metadata (module name, producers) to a WebAssembly file.

Supports both core WebAssembly modules and components. In components, metadata will be added to the outermost component.

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.

name: Option<String>

Add a module or component name to the names section

language: Vec<(String, String)>

Add a programming language to the producers section

processed_by: Vec<(String, String)>

Add a tool and its version to the producers section

sdk: Vec<(String, String)>

Add an SDK and its version to the producers section

authors: Option<Authors>

Available on crate feature oci only.

Contact details of the people or organization responsible, encoded as a freeform string.

description: Option<Description>

Available on crate feature oci only.

A human-readable description of the binary

licenses: Option<Licenses>

Available on crate feature oci only.

License(s) under which contained software is distributed as an SPDX License Expression.

source: Option<Source>

Available on crate feature oci only.

URL to get source code for building the image

homepage: Option<Homepage>

Available on crate feature oci only.

URL to find more information on the binary

revision: Option<Revision>

Available on crate feature oci only.

Source control revision identifier for the packaged software.

version: Option<Version>

Available on crate feature oci only.

Version of the packaged software

Implementations

impl AddMetadata

pub fn to_wasm(&self, input: &[u8]) -> Result<Vec<u8>>

Process a WebAssembly binary. Supports both core WebAssembly modules, and WebAssembly components. The module and component will have, at very least, an empty name and producers section created.

Trait Implementations

impl Clone for AddMetadata

fn clone(&self) -> AddMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddMetadata

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

Formats the value using the given formatter.

impl Default for AddMetadata

fn default() -> AddMetadata

Returns the “default value” for a type.