TopicStream

Struct TopicStream 

Source
pub struct TopicStream<T: Eq + Hash + Clone, M: Clone> { /* private fields */ }
Expand description

A topic-based publish-subscribe stream that allows multiple subscribers to listen to messages associated with specific topics.

§Type Parameters

  • T: The type representing a topic. Must be hashable, comparable, and clonable.
  • M: The message type that will be published and received. Must be clonable.

Implementations§

Source§

impl<T: Eq + Hash + Clone, M: Clone> TopicStream<T, M>

Source

pub fn new(buffer_size: usize) -> Self

Creates a new TopicStream instance with the specified buffer size.

§Arguments
  • buffer_size: The maximum number of messages each topic can hold in its buffer.
§Returns

A new TopicStream instance.

Source

pub fn subscribe(&self, topics: &[T]) -> MultiTopicReceiver<T, M>

Subscribes to a list of topics and returns a MultiTopicReceiver that can receive messages from them.

§Arguments
  • topics: A slice of topics to subscribe to.
§Returns

A MultiTopicReceiver that listens to the specified topics.

Source

pub async fn publish(&self, topic: &T, message: M) -> Result<(), SendError<M>>

Publishes a message to a specific topic. If the topic has no subscribers, the message is ignored.

§Arguments
  • topic: The topic to publish the message to.
  • message: The message to send.
§Returns
  • Ok(()): If the message was successfully sent or there were no subscribers.
  • Err(SendError): If there was an error sending the message.

Trait Implementations§

Source§

impl<T: Clone + Eq + Hash + Clone, M: Clone + Clone> Clone for TopicStream<T, M>

Source§

fn clone(&self) -> TopicStream<T, M>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Eq + Hash + Clone, M: Debug + Clone> Debug for TopicStream<T, M>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T, M> Freeze for TopicStream<T, M>

§

impl<T, M> !RefUnwindSafe for TopicStream<T, M>

§

impl<T, M> Send for TopicStream<T, M>
where T: Send + Sync, M: Send,

§

impl<T, M> Sync for TopicStream<T, M>
where T: Send + Sync, M: Send,

§

impl<T, M> Unpin for TopicStream<T, M>

§

impl<T, M> !UnwindSafe for TopicStream<T, M>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.