Struct Plugin

pub struct Plugin {
    pub type: String,
    pub id: String,
    pub requires: Vec<String>,
    pub platforms: Vec<Platform>,
    pub exports: HashMap<String, String>,
    pub capabilities: Vec<String>,
    pub init_err: Option<Status>,
}

Fields

type: String

Type defines the type of plugin.

See package plugin for a list of possible values. Non core plugins may define their own values during registration.

id: String

ID identifies the plugin uniquely in the system.

requires: Vec<String>

Requires lists the plugin types required by this plugin.

platforms: Vec<Platform>

Platforms enumerates the platforms this plugin will support.

If values are provided here, the plugin will only be operable under the provided platforms.

If this is empty, the plugin will work across all platforms.

If the plugin prefers certain platforms over others, they should be listed from most to least preferred.

exports: HashMap<String, String>

Exports allows plugins to provide values about state or configuration to interested parties.

One example is exposing the configured path of a snapshotter plugin.

capabilities: Vec<String>

Capabilities allows plugins to communicate feature switches to allow clients to detect features that may not be on be default or may be different from version to version.

Use this sparingly.

init_err: Option<Status>

InitErr will be set if the plugin fails initialization.

This means the plugin may have been registered but a non-terminal error was encountered during initialization.

Plugins that have this value set cannot be used.

Trait Implementations

impl Clone for Plugin

fn clone(&self) -> Plugin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Plugin

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

Formats the value using the given formatter.

impl Default for Plugin

fn default() -> Self

Returns the “default value” for a type.

impl Message for Plugin

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for Plugin

const NAME: &'static str = "Plugin"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "containerd.services.introspection.v1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for Plugin

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