Skip to main content

Channel

Struct Channel 

Source
pub struct Channel { /* private fields */ }
Expand description

A pub/sub channel for event distribution.

Implementations§

Source§

impl Channel

Source

pub fn new(id: impl Into<ChannelId>) -> Self

Create a new channel.

Source

pub fn with_config(id: impl Into<ChannelId>, config: ChannelConfig) -> Self

Create a channel with custom configuration.

Source

pub fn id(&self) -> &ChannelId

Get the channel ID.

Source

pub fn publish(&self, event: Event) -> Result<usize, ChannelError>

Publish an event to the channel.

Source

pub fn subscribe( &self, subscriber_id: SubscriberId, ) -> Result<ChannelReceiver, ChannelError>

Subscribe to the channel.

Source

pub fn subscribe_with_filter( &self, subscriber_id: SubscriberId, filter: EventFilter, ) -> Result<ChannelReceiver, ChannelError>

Subscribe with a filter.

Source

pub fn subscribe_with_ack_mode( &self, subscriber_id: SubscriberId, filter: Option<EventFilter>, ack_mode: AckMode, ) -> Result<ChannelReceiver, ChannelError>

Subscribe with a specific ack mode.

Source

pub fn unsubscribe(&self, subscriber_id: &SubscriberId)

Unsubscribe from the channel.

Source

pub fn subscriber_count(&self) -> usize

Get the number of subscribers.

Source

pub fn get_history(&self, count: usize) -> Vec<Event>

Get recent events from history.

Source

pub fn get_history_after(&self, timestamp: u64) -> Vec<Event>

Get events from history after a timestamp.

Source

pub fn stats(&self) -> ChannelStats

Get channel statistics.

Source

pub fn clear_history(&self)

Clear history.

Auto Trait Implementations§

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.