Struct Sender 

pub struct Sender<T> { /* private fields */ }

The sending side of a channel, almost identical to crossbeam_channel::Sender. The only difference is that you can make one channel depend on another channel. If channel A depends on channel B, channel A will ACT disconnected when channel B is disconnected. This mean that dependency is not transitive. If channel Z depends on channel A, channel Z will not ACT disconnected when channel B is disconnected.

Examples

Channel without dependency:

use std::thread;
use crossbeam_channel::RecvError;
use lambda_channel::channel::new_channel;

let (s1, r) = new_channel(None);
let s2 = s1.clone();

thread::spawn(move || s1.send(1).unwrap());
thread::spawn(move || s2.send(2).unwrap());

let msg1 = r.recv().unwrap();
let msg2 = r.recv().unwrap();

assert_eq!(msg1 + msg2, 3);
assert_eq!(r.recv(), Err(RecvError)) // All senders have been dropped

Channel with dependency:

use std::thread;
use crossbeam_channel::{RecvError, SendError};
use lambda_channel::channel::{new_channel, new_channel_with_dependency};

let (s_b1, r_b) = new_channel(None);
// Channel A depends on channel B
let (s_a1, r_a) = new_channel_with_dependency(None, &s_b1, &r_b);
let s_b2 = s_b1.clone();

s_a1.send(0).unwrap();

thread::spawn(move || s_b1.send(1).unwrap());
thread::spawn(move || s_b2.send(2).unwrap());

let msg1 = r_b.recv().unwrap();
let msg2 = r_b.recv().unwrap();

assert_eq!(msg1 + msg2, 3);
assert_eq!(r_b.recv(), Err(RecvError)); // All `B` senders have been dropped

// Channel `B` is disconnected, channel `A` disconnects as well
assert_eq!(s_a1.send(3), Err(SendError(3)));
assert_eq!(r_a.recv(), Ok(0));
assert_eq!(r_a.recv(), Err(RecvError));

Implementations

impl<T> Sender<T>

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

Blocks the current thread until a message is sent or the channel is disconnected.

If the channel is full and not disconnected, this call will block until the send operation can proceed. If the channel becomes disconnected, this call will wake up and return an error. The returned error contains the original message.

If called on a zero-capacity channel, this method will wait for a receive operation to appear on the other side of the channel.

Examples

use std::thread;
use std::time::Duration;
use crossbeam_channel::SendError;
use lambda_channel::channel::new_channel;

let (s, r) = new_channel(Some(1));
assert_eq!(s.send(1), Ok(()));

thread::spawn(move || {
    assert_eq!(r.recv(), Ok(1));
    thread::sleep(Duration::from_secs(1));
    drop(r);
});

assert_eq!(s.send(2), Ok(()));
assert_eq!(s.send(3), Err(SendError(3)));

Examples found in repository

examples/channel_example.rs (line 64)

fn main() {
    let clock = quanta::Clock::new();
    let start = clock.now();

    let mut map: HashMap<char, AtomicU64> = HashMap::new();
    let mut all_alphanumeric: Vec<char> = Vec::new();
    all_alphanumeric.extend('0'..='9');
    all_alphanumeric.extend('a'..='z');
    all_alphanumeric.extend('A'..='Z');
    for char in all_alphanumeric {
        map.insert(char, AtomicU64::new(0));
    }
    let char_counts = Arc::new(map);

    let (tx, rx, thread_pool) = new_lambda_channel(None, None, char_counts.clone(), process_file);
    thread_pool.set_pool_size(4).unwrap();

    let files = vec![
        "./a.txt", "./b.txt", "./c.txt", "./d.txt", "./e.txt", "./f.txt",
    ];

    thread::spawn(move || {
        for file in files {
            tx.send(file).unwrap();
        }
    });

    while let Ok(msg) = rx.recv() {
        if let Err(e) = msg {
            println!("Failed to open file: {}", e);
        }
    }

    let mut total_counts: HashMap<char, u64> = HashMap::new();
    for (k, v) in char_counts.iter() {
        total_counts.insert(*k, v.load(Ordering::Relaxed));
    }

    println!("Execution Time: {:?}", start.elapsed());
    println!("{:?}", total_counts);
}

pub fn try_send(&self, msg: T) -> Result<(), TrySendError<T>>

Attempts to send a message into the channel without blocking.

This method will either send a message into the channel immediately or return an error if the channel is full or disconnected. The returned error contains the original message.

If called on a zero-capacity channel, this method will send the message only if there happens to be a receive operation on the other side of the channel at the same time.

Examples

use crossbeam_channel::TrySendError;
use lambda_channel::channel::new_channel;

let (s, r) = new_channel(Some(1));

assert_eq!(s.try_send(1), Ok(()));
assert_eq!(s.try_send(2), Err(TrySendError::Full(2)));

drop(r);
assert_eq!(s.try_send(3), Err(TrySendError::Disconnected(3)));

pub fn send_timeout( &self, msg: T, timeout: Duration, ) -> Result<(), SendTimeoutError<T>>

Waits for a message to be sent into the channel, but only for a limited time.

If the channel is full and not disconnected, this call will block until the send operation can proceed or the operation times out. If the channel becomes disconnected, this call will wake up and return an error. The returned error contains the original message.

If called on a zero-capacity channel, this method will wait for a receive operation to appear on the other side of the channel.

Examples

use std::thread;
use std::time::Duration;
use crossbeam_channel::SendTimeoutError;
use lambda_channel::channel::new_channel;

let (s, r) = new_channel(Some(0));

thread::spawn(move || {
    thread::sleep(Duration::from_secs(1));
    assert_eq!(r.recv(), Ok(2));
    drop(r);
});

assert_eq!(
    s.send_timeout(1, Duration::from_millis(500)),
    Err(SendTimeoutError::Timeout(1)),
);
assert_eq!(
    s.send_timeout(2, Duration::from_secs(1)),
    Ok(()),
);
assert_eq!(
    s.send_timeout(3, Duration::from_millis(500)),
    Err(SendTimeoutError::Disconnected(3)),
);

pub fn send_deadline( &self, msg: T, deadline: Instant, ) -> Result<(), SendTimeoutError<T>>

Waits for a message to be sent into the channel, but only until a given deadline.

If the channel is full and not disconnected, this call will block until the send operation can proceed or the operation times out. If the channel becomes disconnected, this call will wake up and return an error. The returned error contains the original message.

If called on a zero-capacity channel, this method will wait for a receive operation to appear on the other side of the channel.

Examples

use std::thread;
use std::time::{Duration, Instant};
use crossbeam_channel::SendTimeoutError;
use lambda_channel::channel::new_channel;

let (s, r) = new_channel(Some(0));

thread::spawn(move || {
    thread::sleep(Duration::from_secs(1));
    assert_eq!(r.recv(), Ok(2));
    drop(r);
});

let now = Instant::now();

assert_eq!(
    s.send_deadline(1, now + Duration::from_millis(500)),
    Err(SendTimeoutError::Timeout(1)),
);
assert_eq!(
    s.send_deadline(2, now + Duration::from_millis(1500)),
    Ok(()),
);
assert_eq!(
    s.send_deadline(3, now + Duration::from_millis(2000)),
    Err(SendTimeoutError::Disconnected(3)),
);

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

Note: Zero-capacity channels are always empty.

Examples

use lambda_channel::channel::new_channel;

let (s, _r) = new_channel(None);
assert!(s.is_empty());

s.send(0).unwrap();
assert!(!s.is_empty());

pub fn is_full(&self) -> bool

Returns true if the channel is full.

Note: Zero-capacity channels are always full.

Examples

use lambda_channel::channel::new_channel;

let (s, _r) = new_channel(Some(1));

assert!(!s.is_full());
s.send(0).unwrap();
assert!(s.is_full());

pub fn len(&self) -> usize

Returns the number of messages in the channel.

Examples

use lambda_channel::channel::new_channel;

let (s, _r) = new_channel(None);
assert_eq!(s.len(), 0);

s.send(1).unwrap();
s.send(2).unwrap();
assert_eq!(s.len(), 2);

pub fn capacity(&self) -> Option<usize>

Returns the channel’s capacity.

Examples

use lambda_channel::channel::new_channel;

let (s, _) = new_channel::<i32>(None);
assert_eq!(s.capacity(), None);

let (s, _) = new_channel::<i32>(Some(5));
assert_eq!(s.capacity(), Some(5));

let (s, _) = new_channel::<i32>(Some(0));
assert_eq!(s.capacity(), Some(0));

pub fn same_channel(&self, other: &Sender<T>) -> bool

Returns true if senders belong to the same channel.

Examples

use lambda_channel::channel::new_channel;

let (s, _) = new_channel::<usize>(None);

let s2 = s.clone();
assert!(s.same_channel(&s2));

let (s3, _) = new_channel(None);
assert!(!s.same_channel(&s3));

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Sender<T>

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

Formats the value using the given formatter.