pub struct PubSubBroker { /* private fields */ }Expand description
In-memory pub/sub broker with channel-based messaging, history retention, and glob-pattern subscriptions.
Implementations§
Source§impl PubSubBroker
impl PubSubBroker
Sourcepub fn new(max_history_per_channel: usize) -> Self
pub fn new(max_history_per_channel: usize) -> Self
Create a new broker that retains up to max_history_per_channel
messages per channel.
Sourcepub fn publish(&self, channel: &str, message: &str) -> usize
pub fn publish(&self, channel: &str, message: &str) -> usize
Publish a message to a channel. Returns the number of subscribers that were notified.
Sourcepub fn subscribe(
&self,
channel: &str,
callback: Box<dyn Fn(&PubSubMessage) + Send + Sync>,
) -> u64
pub fn subscribe( &self, channel: &str, callback: Box<dyn Fn(&PubSubMessage) + Send + Sync>, ) -> u64
Subscribe to a channel. Returns a subscription ID that can be used to unsubscribe later.
Sourcepub fn unsubscribe(&self, channel: &str, sub_id: u64) -> bool
pub fn unsubscribe(&self, channel: &str, sub_id: u64) -> bool
Unsubscribe from a channel by subscription ID. Returns true if the subscription was found and removed.
Sourcepub fn history(&self, channel: &str, limit: usize) -> Vec<PubSubMessage>
pub fn history(&self, channel: &str, limit: usize) -> Vec<PubSubMessage>
Get recent message history for a channel, up to limit messages.
Returns messages in chronological order (oldest first).
Sourcepub fn channels(&self) -> Vec<(String, usize)>
pub fn channels(&self) -> Vec<(String, usize)>
List all channels that have at least one subscriber, along with their subscriber counts.
Sourcepub fn subscriber_count(&self, channel: &str) -> usize
pub fn subscriber_count(&self, channel: &str) -> usize
Get the number of subscribers for a specific channel.
Sourcepub fn psubscribe(
&self,
pattern: &str,
callback: Box<dyn Fn(&PubSubMessage) + Send + Sync>,
) -> Vec<u64>
pub fn psubscribe( &self, pattern: &str, callback: Box<dyn Fn(&PubSubMessage) + Send + Sync>, ) -> Vec<u64>
Pattern-subscribe: subscribe to all existing channels whose names match a glob pattern. Returns the subscription IDs created (one per matched channel).
Note: this is a snapshot-based pattern subscribe. Channels created after the call will not be matched automatically.
Sourcepub fn channels_with_history(&self) -> Vec<String>
pub fn channels_with_history(&self) -> Vec<String>
List all channels that have history entries (regardless of whether they have active subscribers).
Auto Trait Implementations§
impl !Freeze for PubSubBroker
impl RefUnwindSafe for PubSubBroker
impl Send for PubSubBroker
impl Sync for PubSubBroker
impl Unpin for PubSubBroker
impl UnsafeUnpin for PubSubBroker
impl UnwindSafe for PubSubBroker
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);