Struct PluginContract 

#[non_exhaustive]
pub struct PluginContract {
    pub plugin: String,
    pub plugin_version: Option<String>,
    pub autumn_web: Option<String>,
    pub experimental_surfaces: Vec<String>,
    pub registered_as: Option<String>,
}

What a plugin declares about its own compatibility.

Built with the fluent constructors and returned from Plugin::contract. Every field is optional: a plugin that declares nothing keeps working exactly as before (ContractVerdict::Undeclared).

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.

plugin: String

The plugin’s crate name, e.g. "autumn-admin-plugin".

plugin_version: Option<String>

The plugin’s own version, when it declares one. Carried purely so the mismatch diagnostic can name it.

autumn_web: Option<String>

A Cargo-style version requirement on autumn-web ("0.7", ">=0.6, <0.9"). None means the plugin declares no range.

experimental_surfaces: Vec<String>

Names of SurfaceTier::Experimental surfaces this plugin knowingly depends on. Reported by autumn plugin-check.

registered_as: Option<String>

The Plugin::name the plugin was registered under, filled in by AppBuilder::plugin.

Not set by the plugin author. It exists because plugin is the plugin’s crate name while route attribution keys on Plugin::name(), and the default name() is std::any::type_name — so a plugin that declares env!("CARGO_PKG_NAME") without overriding name() would otherwise be unfindable by the one identifier autumn plugin-check --plugin-name takes. Carrying both lets the CLI match on either.

Implementations

impl PluginContract

pub fn new(plugin: impl Into<String>) -> Self

Start a contract for the named plugin crate.

Pass env!("CARGO_PKG_NAME") so the name can never drift from the crate it describes.

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

Record the plugin’s own version, so a mismatch diagnostic can name it.

Pass env!("CARGO_PKG_VERSION").

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

Declare the autumn-web range this plugin supports.

The string is a Cargo version requirement: "0.7" (the whole 0.7 series), ">=0.6, <0.9", "=0.7.1". First-party plugins ship in lockstep with the framework and declare their own minor series.

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

Declare that this plugin knowingly depends on an experimental surface.

The name must match a SurfaceTier::Experimental entry in PLUGIN_SURFACES; autumn plugin-check fails on a name it cannot resolve, because a declaration nobody can look up is worse than none.

pub fn label(&self) -> String

The plugin as it should appear in a diagnostic: name version when a version was declared, bare name otherwise.

Trait Implementations

impl Clone for PluginContract

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 PluginContract

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

Formats the value using the given formatter.

impl Default for PluginContract

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PluginContract

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PluginContract

impl PartialEq for PluginContract

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PluginContract

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 PluginContract