Struct ksched::mpsc::Sender

pub struct Sender<T>(_);

The transmission end of a unbounded mpsc channel.

This value is created by the channel function.

Implementations

impl<T> Sender<T>

pub fn is_closed(&self) -> bool

Check whether the channel is closed.

A closed channel cannot be sent to.

Examples

use ksched::sync::mpsc;
use ksched::task;

let (tx, mut rx) = mpsc::channel::<usize>().unwrap();
assert_eq!(tx.is_closed(), false);
rx.close();
assert_eq!(tx.is_closed(), true);

pub fn send(&self, value: T) -> Result<(), T>

Sends a value.

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 closed or allocation failed. 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.

Errors

If the receive half of the channel is closed, either due to close being called or the Receiver handle dropping, the function returns an error. Or if allocation fails during create a message for sending, the function returns an error. The error includes the value passed to send.

Examples

In the following example, each call to send will block until the previously sent value was received.

use ksched::sync::mpsc;
use ksched::task;

let (tx, mut rx) = mpsc::channel().unwrap();

task::spawn(async move {
    for i in 0..10 {
        if let Err(_) = tx.send(i) {
            println!("receiver dropped");
            return;
        }
    }
}).unwrap();

while let Some(i) = rx.recv().await {
    println!("got = {}", i);
}

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Sender<T>

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

Formats the value using the given formatter.

impl<T> Drop for Sender<T>

fn drop(&mut self)

Executes the destructor for this type.