Skip to main content

Registry

Struct Registry 

Source
pub struct Registry { /* private fields */ }
Expand description

Every plugin this binary knows how to build.

Implementations§

Source§

impl Registry

Source

pub fn new() -> Self

Source

pub fn register(&mut self, factory: impl PluginFactory) -> &mut Self

Source

pub fn register_arc(&mut self, factory: Arc<dyn PluginFactory>) -> &mut Self

Source

pub fn get(&self, name: &str) -> Option<&Arc<dyn PluginFactory>>

Source

pub fn iter(&self) -> impl Iterator<Item = &Arc<dyn PluginFactory>>

Source

pub fn names(&self) -> impl Iterator<Item = &str>

The names plugins call themselves, not the normalized keys they are stored under: these are shown to people, in --list-plugins and in the suggestions on an unknown plugin.

Source

pub fn build( &self, specs: &[PluginSpec], meta: &PipelineMeta, host: &mut dyn HostBuilder, ) -> Result<Chain>

Build the chain for one direction.

Entries that do not apply to meta.direction are skipped. On the sink-to-source path the survivors are mirrored, so a declaration [a, b] nests as a(b(payload)) in both directions.

Source

pub fn build_pair( &self, specs: &[PluginSpec], source: &str, sink: &str, peer: Option<&str>, host: &mut dyn HostBuilder, ) -> Result<(Chain, Chain)>

Build both directions at once. Returns (source_to_sink, sink_to_source).

Both share one host, which is how identical side-channel targets end up sharing a single writer.

Trait Implementations§

Source§

impl Debug for Registry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Registry

Source§

fn default() -> Registry

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.