Struct BroadcastChannelWrapper

pub struct BroadcastChannelWrapper<Channel: BroadcastChannel> { /* private fields */ }

Available on crate feature broadcast_channel only.

Helper struct to wrap a broadcast channel Takes care of some of the boilerplate for serialization/deserialization

Implementations

impl<Channel: BroadcastChannel> BroadcastChannelWrapper<Channel>

pub fn new(channel: &Channel, name: impl ToString) -> Result<Self, Error>

Create a new broadcast channel wrapper and subscribe to the channel Unsubscribe is called when the wrapper is dropped

Errors

Will return an error if the channel cannot be subscribed to

pub fn send_sync<T: Serialize>( &self, runtime: &mut Runtime, data: T, ) -> Result<(), Error>

Send a message to the channel, blocking until the message is sent

Errors

Will return an error if the message cannot be serialized or sent

pub async fn send<T: Serialize>( &self, runtime: &mut Runtime, data: T, ) -> Result<(), Error>

Send a message to the channel

Errors

Will return an error if the message cannot be serialized or sent

pub async fn recv<T: DeserializeOwned>( &self, runtime: &mut Runtime, timeout: Option<Duration>, ) -> Result<Option<T>, Error>

Receive a message from the channel, waiting for a message to arrive, or until the timeout is reached

Errors

Will return an error if the message cannot be deserialized or if receiving the message fails

pub fn recv_sync<T: DeserializeOwned>( &self, runtime: &mut Runtime, timeout: Option<Duration>, ) -> Result<Option<T>, Error>

Receive a message from the channel, blocking until a message arrives, or until the timeout is reached

Errors

Will return an error if the message cannot be deserialized or if receiving the message fails

Trait Implementations

impl<Channel: BroadcastChannel> Drop for BroadcastChannelWrapper<Channel>

fn drop(&mut self)

Executes the destructor for this type.