BasicBuilder

Struct BasicBuilder 

Source
pub struct BasicBuilder<Ev>
where Ev: Debug,
{ /* private fields */ }
Expand description

The BasicBuilder helps you to create a BasicMediator.

The BasicBuilder is part of the builder pattern. It has only two functionalities. The first one is adding a Listener via BasicBuilder::add_listener(). The second one is the mandatory BuilderFlow::build(), which returns a BasicMediator.

Implementations§

Source§

impl<Ev> BasicBuilder<Ev>
where Ev: Debug,

Source

pub fn add_listener<F>(self, f: F) -> Self
where F: Listener<Ev>,

Adds a user-defined listener to the BasicBuilder.

The supplied type must be a Listener. As such, it must implement Send and Fn(Ev), besides being 'static.

As a side note, here, Ev is the user-defined event type that must be Clone and Debug.

§Examples

Basic usage:

use mediator_sys::synchronous::basic::*;

#[derive(Debug, Clone)]
enum MyEvent {
    One,
    Two
}

let mediator = BasicMediator::<MyEvent>::builder()
    .add_listener(|ev| {
        /* Your listening logic */
    })
    .build();

Trait Implementations§

Source§

impl<M, Ev> BasicMediatorBuilderInterface<M, Ev> for BasicBuilder<Ev>
where Ev: Debug,

Source§

fn add_listener<F>(self, f: F) -> Self
where F: Listener<Ev>,

Adds a user-defined listener to the BasicBuilder.

To be able to supply a closure that implements Listener, it must satisfy Send and 'static bounds.

Also it must be a Fn(Ev) with a return type of () where Ev is the user-defined event type that must be Clone and Debug.

Source§

impl<Ev> BuilderFlow<BasicMediator<Ev>> for BasicBuilder<Ev>
where Ev: Debug,

Source§

fn build(self) -> BasicMediator<Ev>

Builds the BasicMediator and returns it.

Because BasicMediator implements BuilderInternal, which in turn means, that the BasicBuilder implements BuilderFlow and not crate::builder::TryBuilderFlow, this method will always return a BasicMediator as stated by the return type.

Source§

impl<Ev> BuilderInternal<BasicMediator<Ev>, BasicBuilder<Ev>> for BasicMediator<Ev>
where Ev: Debug,

Source§

fn builder() -> BasicBuilder<Ev>

Creates a BasicBuilder with the goal of producing a BasicMediator.

Auto Trait Implementations§

§

impl<Ev> Freeze for BasicBuilder<Ev>

§

impl<Ev> !RefUnwindSafe for BasicBuilder<Ev>

§

impl<Ev> Send for BasicBuilder<Ev>
where Ev: Send,

§

impl<Ev> !Sync for BasicBuilder<Ev>

§

impl<Ev> Unpin for BasicBuilder<Ev>

§

impl<Ev> !UnwindSafe for BasicBuilder<Ev>

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.