pub struct Sender<T, Codec = Json> { /* private fields */ }Expand description
Sending-half of the broadcast channel.
Cannot be sent over a remote channel. Use feeder to obtain an mpsc sender that feeds this broadcast sender and can be sent over a remote channel.
Implementations§
Source§impl<T, Codec> Sender<T, Codec>
impl<T, Codec> Sender<T, Codec>
Sourcepub fn send(&self, value: T) -> Result<(), SendError<T>>
pub fn send(&self, value: T) -> Result<(), SendError<T>>
Attempts to send a value to all active receivers.
No back-pressure is provided.
Sourcepub fn subscribe<const RECEIVE_BUFFER: usize>(
&self,
send_buffer: usize,
) -> Receiver<T, Codec, RECEIVE_BUFFER>
pub fn subscribe<const RECEIVE_BUFFER: usize>( &self, send_buffer: usize, ) -> Receiver<T, Codec, RECEIVE_BUFFER>
Creates a new receiver that will receive values sent after this call to subscribe.
Sourcepub fn subscribe_with_max_item_size<const RECEIVE_BUFFER: usize, const MAX_ITEM_SIZE: usize>(
&self,
send_buffer: usize,
) -> Receiver<T, Codec, RECEIVE_BUFFER, MAX_ITEM_SIZE>
pub fn subscribe_with_max_item_size<const RECEIVE_BUFFER: usize, const MAX_ITEM_SIZE: usize>( &self, send_buffer: usize, ) -> Receiver<T, Codec, RECEIVE_BUFFER, MAX_ITEM_SIZE>
Creates a new receiver with a custom maximum item size.
Sourcepub fn feeder<const SEND_BUFFER: usize>(&self) -> Sender<T, Codec, SEND_BUFFER>
pub fn feeder<const SEND_BUFFER: usize>(&self) -> Sender<T, Codec, SEND_BUFFER>
Creates an mpsc sender that feeds values to this broadcast sender.
The mpsc sender can be sent over a remote channel. All feeders are disconnected once all receivers are disconnected.
Sourcepub fn receiver_count(&self) -> usize
pub fn receiver_count(&self) -> usize
Returns the number of active receivers.
Trait Implementations§
Auto Trait Implementations§
impl<T, Codec> Freeze for Sender<T, Codec>
impl<T, Codec> RefUnwindSafe for Sender<T, Codec>
impl<T, Codec> Send for Sender<T, Codec>
impl<T, Codec> Sync for Sender<T, Codec>
impl<T, Codec> Unpin for Sender<T, Codec>
impl<T, Codec> UnwindSafe for Sender<T, Codec>
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
Mutably borrows from an owned value. Read more