Struct Metadata

pub struct Metadata {

    pub name: String,
    pub description: String,
    pub version: String,
    pub database: bool,
    pub access_checks: Option<AccessCheckChain>,
    pub escalation_key: Option<String>,
    pub escalated_privileges: Vec<i32>,
    pub author: String,
    pub handles_commands: bool,
    pub handles_messages: bool,
    pub command_name: Option<String>,
    pub aliases: Vec<String>,
    pub arguments: Vec<Argument>,
    pub subcommands: Vec<Command>,
    pub allowed_hosts: Vec<String>,
    pub pool_size: Option<i32>,
}

Metadata for a plugin.

Fields

name: String

The plguins name.

description: String

A short description of the plugin.

version: String

A version string for the plugin. Should follow semver.

@see: https://semver.org/

database: bool

When true, a SQLite3 database will be created for the plugin. @deprecated All plugins get a database by default now.

access_checks: Option<AccessCheckChain>

Access checks

All functionality of this plugin can optionally be gated by accses checks.

escalation_key: Option<String>

A secret escalation key that grants this plugin specific escalated privileges.

escalated_privileges: Vec<i32>

A list of escalated privileges that this plugin requests to use.

author: String

The author of the plugin.

handles_commands: bool

Whether or not this plugin handles commands.

handles_messages: bool

Whether or not this plugin handles messages.

command_name: Option<String>

Optionally override the plugin command name.

aliases: Vec<String>

Optional aliases for the plugin command.

arguments: Vec<Argument>

Arguments for the plugin command.

subcommands: Vec<Command>

Plugin subcommands.

allowed_hosts: Vec<String>

Hosts that this plugin requests permissions to access via HTTP.

pool_size: Option<i32>

Pool size this plugin requests.

Implementations

impl Metadata

pub fn escalation_key(&self) -> &str

Returns the value of escalation_key, or the default value if escalation_key is unset.

pub fn escalated_privileges( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<EscalatedPrivilege>>

Returns an iterator which yields the valid enum values contained in escalated_privileges.

pub fn push_escalated_privileges(&mut self, value: EscalatedPrivilege)

Appends the provided enum value to escalated_privileges.

pub fn command_name(&self) -> &str

Returns the value of command_name, or the default value if command_name is unset.

pub fn pool_size(&self) -> i32

Returns the value of pool_size, or the default value if pool_size is unset.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Metadata

where Metadata: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Metadata

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 PartialEq for Metadata

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

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 Metadata