Struct RegistryMetadata

pub struct RegistryMetadata {
    pub authors: Option<Vec<String>>,
    pub description: Option<String>,
    pub license: Option<String>,
    pub custom_licenses: Option<Vec<CustomLicense>>,
    pub links: Option<Vec<Link>>,
    pub categories: Option<Vec<String>>,
}

Metadata used by a Warg registry

Fields

authors: Option<Vec<String>>

List of authors who has created this package.

description: Option<String>

Package description in markdown format.

license: Option<String>

SPDX License Expression https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/ SPDX License List: https://spdx.org/licenses/

custom_licenses: Option<Vec<CustomLicense>>

A list of custom licenses that should be referenced to from the license expression. https://spdx.github.io/spdx-spec/v2.3/other-licensing-information-detected/

links: Option<Vec<Link>>

A list of links that can contain predefined link types or custom links for use with tooling or registries.

categories: Option<Vec<String>>

A list of categories that a package should be listed under when uploaded to a registry.

Implementations

impl RegistryMetadata

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

Merge into an existing wasm module. Rewrites the module with this registry-metadata section overwriting its existing one, or adds this registry-metadata section if none is present.

pub fn from_wasm(bytes: &[u8]) -> Result<Option<Self>>

Parse a Wasm binary and extract the Registry section, if there is any.

pub fn from_bytes(bytes: &[u8], offset: usize) -> Result<Self>

Gets the registry-matadata from a slice of bytes

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

Validate the RegistryMetadata::license an RegistryMetadata::CustomLicense are valid SPDX expressions.

pub fn get_authors(&self) -> Option<&Vec<String>>

Get authors

pub fn set_authors(&mut self, authors: Option<Vec<String>>)

Set authors

pub fn get_description(&self) -> Option<&String>

Get description

pub fn set_description(&mut self, description: Option<String>)

Set description

pub fn get_license(&self) -> Option<&String>

Get license

pub fn set_license(&mut self, license: Option<String>)

Set license

pub fn get_custom_licenses(&self) -> Option<&Vec<CustomLicense>>

Get custom_licenses

pub fn set_custom_licenses( &mut self, custom_licenses: Option<Vec<CustomLicense>>, )

Set custom_licenses

pub fn get_links(&self) -> Option<&Vec<Link>>

Get links

pub fn set_links(&mut self, links: Option<Vec<Link>>)

Set links

pub fn get_categories(&self) -> Option<&Vec<String>>

Get categories

pub fn set_categories(&mut self, categories: Option<Vec<String>>)

Set categories

Trait Implementations

impl Clone for RegistryMetadata

fn clone(&self) -> RegistryMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegistryMetadata

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

Formats the value using the given formatter.

impl Default for RegistryMetadata

fn default() -> RegistryMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RegistryMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RegistryMetadata

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

Formats the value using the given formatter.

impl PartialEq for RegistryMetadata

fn eq(&self, other: &RegistryMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RegistryMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RegistryMetadata