Struct Sender

pub struct Sender<T> { pub(in ::sync::mpsc) inner: Sender<T> }

The sending-half of Rust's asynchronous channel type.

Messages can be sent through this channel with send.

Note: all senders (the original and its clones) need to be dropped for the receiver to stop blocking to receive messages with Receiver::recv.

Examples

use std::sync::mpsc::channel;
use std::thread;

let (sender, receiver) = channel();
let sender2 = sender.clone();

// First thread owns sender
thread::spawn(move || {
    sender.send(1).unwrap();
});

// Second thread owns sender2
thread::spawn(move || {
    sender2.send(2).unwrap();
});

let msg = receiver.recv().unwrap();
let msg2 = receiver.recv().unwrap();

assert_eq!(3, msg + msg2);

Fields

inner: Sender<T>

Implementations

impl<T> Sender<T>

fn send(&self, t: T) -> Result<(), SendError<T>>

Attempts to send a value on this channel, returning it back if it could not be sent.

A successful send occurs when it is determined that the other end of the channel has not hung up already. An unsuccessful send would be one where the corresponding receiver has already been deallocated. Note that a return value of Err means that the data will never be received, but a return value of Ok does not mean that the data will be received. It is possible for the corresponding receiver to hang up immediately after this function returns Ok.

This method will never block the caller in order to wait for space to become available. (See std::sync for precise guarantees on blocking.)

Examples

use std::sync::mpsc::channel;

let (tx, rx) = channel();

// This send is always successful
tx.send(1).unwrap();

// This send will fail because the receiver is gone
drop(rx);
assert_eq!(tx.send(1).unwrap_err().0, 1);

fn is_disconnected(&self) -> bool

Returns true if the channel is disconnected.

Note that a return value of false does not guarantee the channel will remain connected. The channel may be disconnected immediately after this method returns, so a subsequent Sender::send may still fail with SendError.

Examples

#![feature(mpsc_is_disconnected)]

use std::sync::mpsc::channel;

let (tx, rx) = channel::<i32>();
assert!(!tx.is_disconnected());
drop(rx);
assert!(tx.is_disconnected());

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Sender<T>

Clone a sender to send to other threads.

Note, be aware of the lifetime of the sender because all senders (including the original) need to be dropped in order for Receiver::recv to stop blocking.

impl<T> Debug for Sender<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<T> Share for Sender<T>

impl<T: Send> Send for Sender<T>

impl<T: Send> Sync for Sender<T>

Auto Trait Implementations

impl<T> Freeze for Sender<T> where Sender<T>: Freeze,

impl<T> RefUnwindSafe for Sender<T> where Sender<T>: RefUnwindSafe,

impl<T> Unpin for Sender<T> where Sender<T>: Unpin,

impl<T> UnsafeUnpin for Sender<T> where Sender<T>: UnsafeUnpin,

impl<T> UnwindSafe for Sender<T> where Sender<T>: UnwindSafe,

Blanket Implementations

impl<T> Any for Sender<T> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Sender<T> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Sender<T> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Sender<T> where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for Sender<T>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> SizeHint for Sender<T> where T: ?Sized,

fn lower_bound(&self) -> usize
fn upper_bound(&self) -> Option<usize>

impl<T> SizedTypeProperties for Sender<T>

impl<T> ToOwned for Sender<T> where T: Clone,

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

impl<T, U> Into<U> for Sender<T> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for Sender<T> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for Sender<T> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>