Struct std::sync::channel::Channel

A simple bounded synchronous queue.

Uses a ring buffer and Mutex and CondVar to provide mutual exclusion and signalling.

Example

use std::sync::channel::Channel;
use std::thread::spawn;

// Space for 10 elements
let chan: Channel<i32> = Channel::new(5);

let t = spawn(|&chan| {
    for i in 0..10 {
        chan.send(i).unwrap();
    }
    chan.close();
});

// Prints all the values.
for i in chan {
    println!("{}", i);
}

t.join().unwrap();
Run this example

Fields

• mutex: Mutex

• cond: CondVar

• buffer: &mut [T]

• closed: bool

• reader: usize

• writer: usize

Methods

• fn new(capacity: usize) -> Channel<T>

  source

  Creates a new channel with a given capacity

• fn send(self: &mut Channel<T>, value: T) -> Result<(), ChannelError>

  source

  Send a value to the channel.

  This function will block if the channel is full.

• fn try_send(self: &mut Channel<T>, value: T) -> Result<(), ChannelError>

  source

  Try to send a value to the channel.

  If the channel is full, this function will return WouldBlock.

• fn send_timeout(self: &mut Channel<T>, value: T, timeout: Duration) -> Result<(), ChannelError>

  source

  Try to send a value to the channel with a timeout.

  If the channel is full, this function will return WouldBlock.

• fn recv(self: &mut Channel<T>) -> Result<T, ChannelError>

  source

  Receive a value from the channel.

  This function will block if the channel is empty.

• fn try_recv(self: &mut Channel<T>) -> Result<T, ChannelError>

  source

  Try to receive a value from the channel.

  If the channel is empty, this function will return WouldBlock.

• fn recv_timeout(self: &mut Channel<T>, timeout: Duration) -> Result<T, ChannelError>

  source

  Try to receive a value from the channel with a timeout.

  If the channel is empty, this function will return WouldBlock.

• fn close(self: &mut Channel<T>)

  source

  Close the channel.

  All subsequent calls to send will return Closed. After all the values have been received, recv will return Closed too.

• fn iter(self: &mut Channel<T>) -> ChannelIterator<Channel<T>, T>

  source

  Returns an iterator over the elements of this iterable.

  See Iterable for details.

• fn free(self: &mut Channel<T>)

  source

  Frees the memory backing the object.

Mixins

• mixin ConditionExt<Channel<T>>