Struct bulwark_config::Plugin

pub struct Plugin {
    pub reference: String,
    pub path: String,
    pub weight: f64,
    pub config: Map<String, Value>,
    pub permissions: Permissions,
}

The configuration for an individual plugin.

This structure will be wrapped by structs in the host environment.

Fields

reference: String

The plugin reference key. Should be limited to ASCII lowercase a-z plus underscores. Maximum 96 characters.

path: String

The path to the plugin WASM file.

weight: f64

A weight to multiply this plugin’s decision values by.

A 1.0 value has no effect on the decision. See bulwark_decision::Decision::weight.

config: Map<String, Value>

JSON-serializable configuration passed into the plugin environment.

The host environment will not do anything with this value beyond serialization.

permissions: Permissions

The permissions granted to this plugin.

Any attempt to perform an operation within the plugin sandbox that requires a permission to be set will fail.

Implementations

impl Plugin

pub fn config_to_json(&self) -> Result<Vec<u8>, ConfigSerializationError>

Serializes the config value to JSON bytes.

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() -> Plugin

Returns the “default value” for a type.

impl Validate for Plugin

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for Plugin

type Args = ()

fn validate_args(&self, args: Self::Args) -> Result<(), ValidationErrors>