Struct PluginSpec 

pub struct PluginSpec {
    pub name: String,
    pub direction: DirectionSpec,
    pub alias: Option<String>,
    pub detach: Option<bool>,
    pub config: Map<String, Value>,
}

A declared pipeline entry: which plugin, on which path, with what config.

In TOML the plugin’s own options are flattened alongside name and direction:

[[plugin]]
name = "tee"
direction = "both"
file = "dump.log"
format = "hex"

Fields

name: String

direction: DirectionSpec

alias: Option<String>

A name for this instance, used in logs and as the default label for stages that print one. Without it a stage is called after its plugin, with #n appended when the same plugin appears twice on one path.

detach: Option<bool>

Override the plugin’s default placement. true runs this stage on its own task behind a bounded channel.

config: Map<String, Value>

Plugin-defined options, opaque to the host.

Implementations

impl PluginSpec

pub fn new(name: impl Into<String>, direction: DirectionSpec) -> Self

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

pub fn detached(self, detach: bool) -> Self

pub fn with(self, key: impl Into<String>, value: impl Into<Value>) -> Self

pub fn set( &mut self, key: impl Into<String>, value: impl Into<Value>, ) -> &mut Self

Trait Implementations

impl Clone for PluginSpec

fn clone(&self) -> PluginSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginSpec

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

Formats the value using the given formatter.

impl Default for PluginSpec

fn default() -> PluginSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PluginSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PluginSpec

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

Formats the value using the given formatter.

impl Serialize for PluginSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.