Struct PluginMetadata 

#[non_exhaustive]
pub struct PluginMetadata {
    pub id: String,
    pub name: String,
    pub version: String,
    pub api_version: u32,
    pub description: Option<String>,
}

Who a plugin is. Build it with PluginMetadata::new.

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.

id: String

A stable, unique identifier: lowercase letters, digits, -, _ and ..

name: String

A human-readable name.

version: String

The plugin’s own version, usually env!("CARGO_PKG_VERSION").

api_version: u32

The PLUGIN_API_VERSION the plugin was built against.

description: Option<String>

One line on what the plugin adds.

Implementations

impl PluginMetadata

pub fn new( id: impl Into<String>, name: impl Into<String>, version: impl Into<String>, ) -> Self

Metadata for a plugin built against this crate’s PLUGIN_API_VERSION.

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

Add a one-line description.

Trait Implementations

impl Clone for PluginMetadata

fn clone(&self) -> Self

Returns a duplicate 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 Eq for PluginMetadata

impl PartialEq for PluginMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PluginMetadata