# tokio::sync::mpsc::UnboundedSender - Rust
API documentation for the Rust `UnboundedSender` struct in crate `tokio`.
Keywords: rust, rustlang, rust-lang, UnboundedSender

# Struct tokio::sync::mpsc::UnboundedSender [−] [src]

    pub struct UnboundedSender<T> { /* fields omitted */ }

Send values to the associated `UnboundedReceiver`.

Instances are created by the `unbounded_channel` function.

## Implementations

### `impl<T> UnboundedSender<T>` [src]

#### `pub fn send(&self, message: T) -> Result<(), SendError<T>>` [src]

Attempts to send a message on this `UnboundedSender` without blocking.

This method is not marked async because sending a message to an unbounded channel never requires any form of waiting. Because of this, the `send` method can be used in both synchronous and asynchronous code without problems.

If the receive half of the channel is closed, either due to `close` being called or the `UnboundedReceiver` having been dropped, this function returns an error. The error includes the value passed to `send`.

#### `pub async fn closed(&self)` [src]

Completes when the receiver has dropped.

This allows the producers to get notified when interest in the produced values is canceled and immediately stop doing work.

# Examples

    use tokio::sync::mpsc;

    #[tokio::main]
    async fn main() {
        let (tx1, rx) = mpsc::unbounded_channel::<()>();
        let tx2 = tx1.clone();
        let tx3 = tx1.clone();
        let tx4 = tx1.clone();
        let tx5 = tx1.clone();
        tokio::spawn(async move {
            drop(rx);
        });

        futures::join!(
            tx1.closed(),
            tx2.closed(),
            tx3.closed(),
            tx4.closed(),
            tx5.closed()
        );
    }

#### `pub fn is_closed(&self) -> bool` [src]

Checks if the channel has been closed. This happens when the `UnboundedReceiver` is dropped, or when the `UnboundedReceiver::close` method is called.

    let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<()>();
    assert!(!tx.is_closed());

    let tx2 = tx.clone();
    assert!(!tx2.is_closed());

    drop(rx);
    assert!(tx.is_closed());
    assert!(tx2.is_closed());

#### `pub fn same_channel(&self, other: &Self) -> bool` [src]

Returns `true` if senders belong to the same channel.

# Examples

    let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<()>();
    let  tx2 = tx.clone();
    assert!(tx.same_channel(&tx2));

    let (tx3, rx3) = tokio::sync::mpsc::unbounded_channel::<()>();
    assert!(!tx3.same_channel(&tx2));

## Trait Implementations

### `impl<T> Clone for UnboundedSender<T>` [src]

#### `fn clone(&self) -> Self` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl<T> Debug for UnboundedSender<T>` [src]

#### `fn fmt(&self, fmt: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `impl<T> !RefUnwindSafe for UnboundedSender<T>` [src]

### `impl<T> Send for UnboundedSender<T> where
T: Send,` [src]

### `impl<T> Sync for UnboundedSender<T> where
T: Send,` [src]

### `impl<T> Unpin for UnboundedSender<T>` [src]

### `impl<T> !UnwindSafe for UnboundedSender<T>` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub 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;`
` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub 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;`
` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `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.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.