Struct PluginMetadata

#[non_exhaustive]
pub struct PluginMetadata {
    pub version: Option<String>,
}

Metadata about the installed plugin. This is cached in the registry file along with the signatures. None of the metadata fields are required, and more may be added in the future.

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.

version: Option<String>

The version of the plugin itself, as self-reported.

Implementations

impl PluginMetadata

pub const fn new() -> PluginMetadata

Create empty metadata.

pub fn with_version(self, version: impl Into<String>) -> Self

Set the version of the plugin on the metadata. A suggested way to construct this is:

PluginMetadata::new().with_version(env!("CARGO_PKG_VERSION"))

which will use the version of your plugin’s crate from its Cargo.toml file.

Trait Implementations

impl Clone for PluginMetadata

fn clone(&self) -> PluginMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluginMetadata

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

Formats the value using the given formatter.

impl Default for PluginMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PluginMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PluginMetadata

fn eq(&self, other: &PluginMetadata) -> 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 PluginMetadata

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 PluginMetadata