pub struct SyncSender<T> { /* fields omitted */ }
The sending-half of Rust's synchronous sync_channel
type.
Messages can be sent through this channel with send
or try_send
.
send
will block if there is no space in the internal buffer.
use std::sync::mpsc::sync_channel; use std::thread; // Create a sync_channel with buffer size 2 let (sync_sender, receiver) = sync_channel(2); let sync_sender2 = sync_sender.clone(); // First thread owns sync_sender thread::spawn(move || { sync_sender.send(1).unwrap(); sync_sender.send(2).unwrap(); }); // Second thread owns sync_sender2 thread::spawn(move || { sync_sender2.send(3).unwrap(); // thread will now block since the buffer is full println!("Thread unblocked!"); }); let mut msg; msg = receiver.recv().unwrap(); println!("message {} received", msg); // "Thread unblocked!" will be printed now msg = receiver.recv().unwrap(); println!("message {} received", msg); msg = receiver.recv().unwrap(); println!("message {} received", msg);
impl<T> SyncSender<T>
[src]
pub fn send(&self, t: T) -> Result<(), SendError<T>>
[src]
Sends a value on this synchronous channel.
This function will block until space in the internal buffer becomes available or a receiver is available to hand off the message to.
Note that a successful send does not guarantee that the receiver will ever see the data if there is a buffer on this channel. Items may be enqueued in the internal buffer for the receiver to receive at a later time. If the buffer size is 0, however, the channel becomes a rendezvous channel and it guarantees that the receiver has indeed received the data if this function returns success.
This function will never panic, but it may return Err
if the Receiver
has disconnected and is no longer able to receive information.
use std::sync::mpsc::sync_channel; use std::thread; // Create a rendezvous sync_channel with buffer size 0 let (sync_sender, receiver) = sync_channel(0); thread::spawn(move || { println!("sending message..."); sync_sender.send(1).unwrap(); // Thread is now blocked until the message is received println!("...message received!"); }); let msg = receiver.recv().unwrap(); assert_eq!(1, msg);
pub fn try_send(&self, t: T) -> Result<(), TrySendError<T>>
[src]
Attempts to send a value on this channel without blocking.
This method differs from send
by returning immediately if the channel's buffer is full or no receiver is waiting to acquire some data. Compared with send
, this function has two failure cases instead of one (one for disconnection, one for a full buffer).
See send
for notes about guarantees of whether the receiver has received the data or not if this function is successful.
use std::sync::mpsc::sync_channel; use std::thread; // Create a sync_channel with buffer size 1 let (sync_sender, receiver) = sync_channel(1); let sync_sender2 = sync_sender.clone(); // First thread owns sync_sender thread::spawn(move || { sync_sender.send(1).unwrap(); sync_sender.send(2).unwrap(); // Thread blocked }); // Second thread owns sync_sender2 thread::spawn(move || { // This will return an error and send // no message if the buffer is full let _ = sync_sender2.try_send(3); }); let mut msg; msg = receiver.recv().unwrap(); println!("message {} received", msg); msg = receiver.recv().unwrap(); println!("message {} received", msg); // Third message may have never been sent match receiver.try_recv() { Ok(msg) => println!("message {} received", msg), Err(_) => println!("the third message was never sent"), }
impl<T> Clone for SyncSender<T>
[src]
fn clone(&self) -> SyncSender<T>
[src]
fn clone_from(&mut self, source: &Self)
[src]
impl<T> Debug for SyncSender<T>
[src]1.8.0
impl<T> Drop for SyncSender<T>
[src]
impl<T: Send> Send for SyncSender<T>
[src]
impl<T> RefUnwindSafe for SyncSender<T>
impl<T> Sync for SyncSender<T> where
T: Send,
impl<T> Unpin for SyncSender<T>
impl<T> UnwindSafe for SyncSender<T>
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/sync/mpsc/struct.SyncSender.html