pub struct BroadcastConfig {
pub max_subscribers_per_channel: usize,
pub max_channels: usize,
pub heartbeat_interval: Duration,
pub client_timeout: Duration,
pub allow_client_events: bool,
}Expand description
Configuration for the broadcaster.
Fields§
§max_subscribers_per_channel: usizeMaximum subscribers per channel (0 = unlimited).
max_channels: usizeMaximum channels (0 = unlimited).
heartbeat_interval: DurationHeartbeat interval for WebSocket connections.
client_timeout: DurationClient timeout (disconnect if no activity).
allow_client_events: boolWhether to allow client-to-client messages (whisper).
Implementations§
Source§impl BroadcastConfig
impl BroadcastConfig
Sourcepub fn new() -> BroadcastConfig
pub fn new() -> BroadcastConfig
Create a new broadcast config with defaults.
Sourcepub fn from_env() -> BroadcastConfig
pub fn from_env() -> BroadcastConfig
Create configuration from environment variables.
Reads the following environment variables:
BROADCAST_MAX_SUBSCRIBERS: Max subscribers per channel (default: unlimited)BROADCAST_MAX_CHANNELS: Max total channels (default: unlimited)BROADCAST_HEARTBEAT_INTERVAL: Heartbeat interval in seconds (default: 30)BROADCAST_CLIENT_TIMEOUT: Client timeout in seconds (default: 60)BROADCAST_ALLOW_CLIENT_EVENTS: Allow whisper messages (default: true)
§Example
use ferro_broadcast::BroadcastConfig;
let config = BroadcastConfig::from_env();
let broadcaster = Broadcaster::with_config(config);Sourcepub fn max_subscribers_per_channel(self, max: usize) -> BroadcastConfig
pub fn max_subscribers_per_channel(self, max: usize) -> BroadcastConfig
Set maximum subscribers per channel.
Sourcepub fn max_channels(self, max: usize) -> BroadcastConfig
pub fn max_channels(self, max: usize) -> BroadcastConfig
Set maximum channels.
Sourcepub fn heartbeat_interval(self, interval: Duration) -> BroadcastConfig
pub fn heartbeat_interval(self, interval: Duration) -> BroadcastConfig
Set heartbeat interval.
Sourcepub fn client_timeout(self, timeout: Duration) -> BroadcastConfig
pub fn client_timeout(self, timeout: Duration) -> BroadcastConfig
Set client timeout.
Sourcepub fn allow_client_events(self, allow: bool) -> BroadcastConfig
pub fn allow_client_events(self, allow: bool) -> BroadcastConfig
Set whether client events (whisper) are allowed.
Trait Implementations§
Source§impl Clone for BroadcastConfig
impl Clone for BroadcastConfig
Source§fn clone(&self) -> BroadcastConfig
fn clone(&self) -> BroadcastConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for BroadcastConfig
impl Debug for BroadcastConfig
Source§impl Default for BroadcastConfig
impl Default for BroadcastConfig
Source§fn default() -> BroadcastConfig
fn default() -> BroadcastConfig
Auto Trait Implementations§
impl Freeze for BroadcastConfig
impl RefUnwindSafe for BroadcastConfig
impl Send for BroadcastConfig
impl Sync for BroadcastConfig
impl Unpin for BroadcastConfig
impl UnsafeUnpin for BroadcastConfig
impl UnwindSafe for BroadcastConfig
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);