Struct Faucet

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

Implementations

impl<T> Faucet<T>

pub fn new(max_len: usize) -> Self

Creates a new faucet with a maximum queue length.

pub fn new_with_cancellation( max_len: usize, cancellation: CancellationToken, ) -> Self

Creates a new faucet with a maximum queue length and a cancellation source.

Providing an existing cancellation token is useful when you have a “parent” cancellation token.

Cancelling the token will prevent any additional values from being pushed onto the queue, and will drain any values already in the queue.

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn end(&self)

Cancels the faucet, preventing any additional values from being pushed onto the queue. Any values already in the queue will be drained.

pub fn is_finished(&self) -> bool

Returns true if the faucet has been cancelled and has no more values remaining in the queue to be drained.

pub fn is_pending(&self) -> bool

Returns true if the faucet is either: (a) accepting values, or (b) is cancelled but has not been fully drained.

pub fn is_cancelled(&self) -> bool

Returns true if the faucet has been cancelled and will not accept any additional values pushed onto the queue.

pub async fn cancelled(&self)

pub async fn push(&self, value: T) -> ControlFlow<(), ()>

Pushes a value onto the queue or waits until space is available.

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

Attempts to push a value onto the queue, returning an error with the original value if the queue is full.

pub async fn next(&self) -> Option<T>

Attempts to pop a value from the queue, returning None if the queue has been cancelled and finished draining.

pub fn try_pop(&self) -> Option<T>

Attempts to pop a value from the queue, returning None if the queue is currently empty.

Trait Implementations

impl<T> Clone for Faucet<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> Debug for Faucet<T>

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

Formats the value using the given formatter.