Struct Pipe 

pub(crate) struct Pipe {
    pub(crate) head: AtomicUsize,
    pub(crate) tail: AtomicUsize,
    pub(crate) reader: AtomicWaker,
    pub(crate) writer: AtomicWaker,
    pub(crate) closed: AtomicBool,
    pub(crate) buffer: *mut u8,
    pub(crate) cap: usize,
}

The inner ring buffer.

Head and tail indices are in the range 0..2*cap, even though they really map onto the 0..cap range. The distance between head and tail indices is never more than cap.

The reason why indices are not in the range 0..cap is because we need to distinguish between the pipe being empty and being full. If head and tail were in 0..cap, then head == tail could mean the pipe is either empty or full, but we don’t know which!

Fields

head: AtomicUsize

The head index, moved by the reader, in the range 0..2*cap.

tail: AtomicUsize

The tail index, moved by the writer, in the range 0..2*cap.

reader: AtomicWaker

A waker representing the blocked reader.

writer: AtomicWaker

A waker representing the blocked writer.

closed: AtomicBool

Set to true if the reader or writer was dropped.

buffer: *mut u8

The byte buffer.

cap: usize

The buffer capacity.

Implementations

impl Pipe

pub(crate) fn len(&self) -> usize

Get the length of the data in the pipe.

Trait Implementations

impl Drop for Pipe

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Pipe

impl Sync for Pipe