Struct Builder

pub struct Builder<T, Mode = SingleConsumer> { /* private fields */ }

Builds a Cushy channel.

This type can be used to create all types of channels supported by Cushy. See the channel module documentation for an overview of the channels provided.

Implementations

impl<T> Builder<T, SingleConsumer>

pub const fn new() -> Self

Returns a builder for a Cushy channel.

The default builder will create an unbounded, Multi-Producer, Single-Consumer channel. See the channel module documentation for an overview of the channels provided.

impl<T, Mode> Builder<T, Mode>

where T: Send + 'static, Mode: ChannelMode<T> + ChannelMode<T, Next = <Mode as ChannelMode<T>>::Next>,

pub fn on_receive<Map>( self, on_receive: Map, ) -> Builder<T, <Mode as ChannelMode<T>>::Next>

where Map: FnMut(T) + Send + 'static,

Invokes on_receive each time a value is sent to this channel.

This function assumes on_receive may block while waiting on another thread, another process, another callback, a network request, a locking primitive, or any other number of ways that could impact other callbacks from executing.

pub fn on_receive_try<Map>( self, map: Map, ) -> Builder<T, <Mode as ChannelMode<T>>::Next>

where Map: FnMut(T) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes on_receive each time a value is sent to this channel. Once an error is returned, this callback will be removed from the channel.

This function assumes on_receive may block while waiting on another thread, another process, another callback, a network request, a locking primitive, or any other number of ways that could impact other callbacks from executing.

Once the last callback associated with a channel is removed, Senders will begin returning disconnected errors.

pub fn on_receive_nonblocking<Map>( self, on_receive: Map, ) -> Builder<T, <Mode as ChannelMode<T>>::Next>

where Map: FnMut(T) + Send + 'static,

Invokes on_receive each time a value is sent to this channel.

This function assumes on_receive will not block while waiting on another thread, another process, another callback, a network request, a locking primitive, or any other number of ways that could impact other callbacks from executing in a shared environment.

pub fn on_receive_nonblocking_try<Map>( self, map: Map, ) -> Builder<T, <Mode as ChannelMode<T>>::Next>

where Map: FnMut(T) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes on_receive each time a value is sent to this channel. Once an error is returned, this callback will be removed from the channel.

This function assumes on_receive will not block while waiting on another thread, another process, another callback, a network request, a locking primitive, or any other number of ways that could impact other callbacks from executing in a shared environment.

Once the last callback associated with a channel is removed, Senders will begin returning disconnected errors.

pub fn on_receive_async<Map, Fut>( self, on_receive: Map, ) -> Builder<T, <Mode as ChannelMode<T>>::Next>

where Map: FnMut(T) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Invokes on_receive each time a value is sent to this channel.

pub fn on_receive_async_try<Map, Fut>( self, on_receive: Map, ) -> Builder<T, <Mode as ChannelMode<T>>::Next>

where Map: FnMut(T) -> Fut + Send + 'static, Fut: Future<Output = Result<(), CallbackDisconnected>> + Send + 'static,

Invokes on_receive each time a value is sent to this channel. The returned future will then be awaited. Once an error is returned, this callback will be removed from the channel.

Once the last callback associated with a channel is removed, Senders will begin returning disconnected errors.

pub fn broadcasting(self) -> Builder<T, Broadcast<T>>

Returns this builder reconfigured to create a BroadcastChannel.

See the channel module documentation for an overview of the channels provided.

pub fn bounded(self, capacity: usize) -> Self

Restricts this channel to capacity values queued.

pub fn finish(self) -> Mode::Channel

Returns the finished channel.

Trait Implementations

impl<T> Default for Builder<T, SingleConsumer>

fn default() -> Self

Returns the “default value” for a type.