pub struct Broadcaster { /* private fields */ }Expand description
The broadcaster manages channels and client connections.
Implementations§
Source§impl Broadcaster
impl Broadcaster
Sourcepub fn new() -> Broadcaster
pub fn new() -> Broadcaster
Create a new broadcaster with default configuration.
Sourcepub fn with_config(config: BroadcastConfig) -> Broadcaster
pub fn with_config(config: BroadcastConfig) -> Broadcaster
Create a new broadcaster with the given configuration.
Set the channel authorizer.
Sourcepub fn config(&self) -> &BroadcastConfig
pub fn config(&self) -> &BroadcastConfig
Get the configuration.
Sourcepub fn add_client(&self, socket_id: String, sender: Sender<ServerMessage>)
pub fn add_client(&self, socket_id: String, sender: Sender<ServerMessage>)
Register a new client connection.
Sourcepub fn remove_client(&self, socket_id: &str)
pub fn remove_client(&self, socket_id: &str)
Remove a client and clean up their subscriptions.
Sourcepub async fn subscribe(
&self,
socket_id: &str,
channel_name: &str,
auth: Option<&str>,
member_info: Option<PresenceMember>,
) -> Result<(), Error>
pub async fn subscribe( &self, socket_id: &str, channel_name: &str, auth: Option<&str>, member_info: Option<PresenceMember>, ) -> Result<(), Error>
Subscribe a client to a channel.
Sourcepub async fn unsubscribe(&self, socket_id: &str, channel_name: &str)
pub async fn unsubscribe(&self, socket_id: &str, channel_name: &str)
Unsubscribe a client from a channel.
Sourcepub async fn broadcast<T>(
&self,
channel: &str,
event: &str,
data: T,
) -> Result<(), Error>where
T: Serialize,
pub async fn broadcast<T>(
&self,
channel: &str,
event: &str,
data: T,
) -> Result<(), Error>where
T: Serialize,
Broadcast a message to a channel.
Sourcepub async fn whisper(
&self,
socket_id: &str,
channel_name: &str,
event: &str,
data: Value,
) -> Result<(), Error>
pub async fn whisper( &self, socket_id: &str, channel_name: &str, event: &str, data: Value, ) -> Result<(), Error>
Forward a client event (whisper) to other subscribers of the same channel.
Used for client-to-client messaging such as typing indicators and cursor positions.
Only works when allow_client_events is enabled in configuration.
The sender is excluded from receiving the whispered message.
Sourcepub async fn broadcast_except<T>(
&self,
channel: &str,
event: &str,
data: T,
except_socket_id: &str,
) -> Result<(), Error>where
T: Serialize,
pub async fn broadcast_except<T>(
&self,
channel: &str,
event: &str,
data: T,
except_socket_id: &str,
) -> Result<(), Error>where
T: Serialize,
Broadcast to a channel, excluding a specific client.
Sourcepub async fn check_auth(&self, auth_data: &AuthData) -> bool
pub async fn check_auth(&self, auth_data: &AuthData) -> bool
Check if a client would be authorized for a channel.
Returns true if:
- Channel is public (no auth needed)
- Channel is private/presence AND authorizer returns true
Returns false if:
- Channel is private/presence AND no authorizer registered
- Channel is private/presence AND authorizer denies access
Used by the broadcasting auth HTTP endpoint to validate authorization without subscribing the client.
Sourcepub fn get_channel(&self, name: &str) -> Option<ChannelInfo>
pub fn get_channel(&self, name: &str) -> Option<ChannelInfo>
Get channel info.
Sourcepub fn client_count(&self) -> usize
pub fn client_count(&self) -> usize
Get number of connected clients.
Sourcepub fn channel_count(&self) -> usize
pub fn channel_count(&self) -> usize
Get number of active channels.
Trait Implementations§
Source§impl Clone for Broadcaster
impl Clone for Broadcaster
Source§fn clone(&self) -> Broadcaster
fn clone(&self) -> Broadcaster
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for Broadcaster
impl Default for Broadcaster
Source§fn default() -> Broadcaster
fn default() -> Broadcaster
Auto Trait Implementations§
impl Freeze for Broadcaster
impl !RefUnwindSafe for Broadcaster
impl Send for Broadcaster
impl Sync for Broadcaster
impl Unpin for Broadcaster
impl UnsafeUnpin for Broadcaster
impl !UnwindSafe for Broadcaster
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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);