Struct MessageChannel

pub struct MessageChannel { /* private fields */ }

Available on crate feature flume only.

Message channel for sending and receiving cloud events.

Implementations

impl MessageChannel

pub fn new() -> Self

Creates a new instance.

pub fn with_subscription(sub: Subscription) -> Self

Creates a new instance with the subscription.

pub fn shared() -> &'static Self

Returns a reference to the shared message channel.

pub fn subscriber_count(&self) -> usize

Get the number of subscribers that currently exist.

pub fn try_send( &self, message: impl Into<CloudEvent>, ) -> Result<(), TrySendError<CloudEvent>>

Attempts to send a message to all receivers in the channel except this one. If the channel is full or all receivers have been dropped, an error is returned.

pub async fn send( &self, message: impl Into<CloudEvent>, ) -> Result<(), SendError<CloudEvent>>

Asynchronously sends a message to all receivers in the channel except this one, returning an error if all receivers have been dropped. If the channel is full, it will yield to the async runtime.

pub fn sink(&self) -> impl Sink<CloudEvent>

Returns a sink that allows asynchronously sending messages into the channel.

pub fn stream(&self) -> impl Stream<Item = CloudEvent> + '_

Returns a stream that allows asynchronously receiving messages from the channel.

pub fn into_stream(self) -> impl Stream<Item = CloudEvent>

Converts self into a stream that allows asynchronously receiving messages from the channel.

Trait Implementations

impl Clone for MessageChannel

fn clone(&self) -> MessageChannel

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MessageChannel

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

Formats the value using the given formatter.

impl Default for MessageChannel

fn default() -> Self

Returns the “default value” for a type.