pub enum Socket<T, Id> {
AtMostOne(Option<T>),
ExactlyOne(T),
AtLeastOne(HashMap<Id, T>),
Any(HashMap<Id, T>),
}Expand description
Container for plugin instances or dispatch results.
The variant corresponds directly to the interface’s InterfaceCardinality:
| Cardinality | Socket Variant | Contents |
|---|---|---|
ExactlyOne | ExactlyOne( T ) | Single value, guaranteed present |
AtMostOne | AtMostOne( Option<T> ) | Optional single value |
AtLeastOne | AtLeastOne( HashMap ) | Map of plugin ID → value, at least one entry |
Any | Any( HashMap ) | Map of plugin ID → value, may be empty |
When used with PluginTreeHead::dispatch, T is Result<Val, DispatchError>.
Variants§
AtMostOne(Option<T>)
Zero or one value. Used when cardinality is AtMostOne.
ExactlyOne(T)
Exactly one value, guaranteed present. Used when cardinality is ExactlyOne.
AtLeastOne(HashMap<Id, T>)
One or more values keyed by plugin ID. Used when cardinality is AtLeastOne.
Any(HashMap<Id, T>)
Zero or more values keyed by plugin ID. Used when cardinality is Any.
Trait Implementations§
Auto Trait Implementations§
impl<T, Id> Freeze for Socket<T, Id>where
T: Freeze,
impl<T, Id> RefUnwindSafe for Socket<T, Id>where
T: RefUnwindSafe,
Id: RefUnwindSafe,
impl<T, Id> Send for Socket<T, Id>
impl<T, Id> Sync for Socket<T, Id>
impl<T, Id> Unpin for Socket<T, Id>
impl<T, Id> UnwindSafe for Socket<T, Id>where
T: UnwindSafe,
Id: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<X> Pipe for X
impl<X> Pipe for X
Source§fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Returnwhere
Function: FnOnce(&'a Self) -> Return,
fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Returnwhere
Function: FnOnce(&'a Self) -> Return,
Source§fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Returnwhere
Function: FnOnce(&'a mut Self) -> Return,
fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Returnwhere
Function: FnOnce(&'a mut Self) -> Return,
Source§fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Return
fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Return
Apply
f to &self where f takes a single parameter of type Param
and Self implements trait AsRef<Param>. Read moreSource§fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Return
fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Return
Apply
f to &mut self where f takes a single parameter of type Param
and Self implements trait AsMut<Param>. Read moreSource§fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return
fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return
Apply
f to &self where f takes a single parameter of type Param
and Self implements trait Deref<Target = Param>. Read moreSource§fn pipe_deref_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function,
) -> Returnwhere
Self: DerefMut<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,
fn pipe_deref_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function,
) -> Returnwhere
Self: DerefMut<Target = Param>,
Param: 'a + ?Sized,
Function: FnOnce(&'a mut Param) -> Return,
Apply
f to &mut self where f takes a single parameter of type Param
and Self implements trait DerefMut<Target = Param>. Read moreSource§fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Return
fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Return
Apply
f to &self where f takes a single parameter of type Param
and Self implements trait Borrow<Param>. Read moreSource§fn pipe_borrow_mut<'a, Param, Return, Function>(
&'a mut self,
f: Function,
) -> Return
fn pipe_borrow_mut<'a, Param, Return, Function>( &'a mut self, f: Function, ) -> Return
Apply
f to &mut self where f takes a single parameter of type Param
and Self implements trait BorrowMut<Param>. Read more