Struct BiteQueue 

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

A FIFO queue that lends transactional batches.

Implementations

impl<T> BiteQueue<T>

pub const fn new() -> Self

Creates an empty queue.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty queue with space for at least capacity items.

pub fn push(&mut self, item: T)

Adds an item at the back.

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

Returns the next item without removing it.

pub fn len(&self) -> usize

Returns the number of queued items.

pub fn is_empty(&self) -> bool

Returns whether the queue contains no items.

pub fn iter(&self) -> impl ExactSizeIterator<Item = &T> + DoubleEndedIterator

Iterates in FIFO order without removing items.

Examples found in repository

examples/worker.rs (line 14)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut queue = BiteQueue::from_iter(["task-1", "task-2", "task-3"]);

    let completed = queue.bite(2)?.commit();
    println!("completed: {completed:?}");

    {
        let retry = queue.bite(1)?;
        println!("will retry: {:?}", retry.front());
    }

    println!("remaining: {:?}", queue.iter().collect::<Vec<_>>());
    Ok(())
}

pub fn bite(&mut self, maximum: usize) -> Result<Bite<'_, T>, BiteError>

Takes up to maximum items as a transactional bite.

Dropping the returned bite without committing it restores the items.

Examples found in repository

examples/worker.rs (line 6)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut queue = BiteQueue::from_iter(["task-1", "task-2", "task-3"]);

    let completed = queue.bite(2)?.commit();
    println!("completed: {completed:?}");

    {
        let retry = queue.bite(1)?;
        println!("will retry: {:?}", retry.front());
    }

    println!("remaining: {:?}", queue.iter().collect::<Vec<_>>());
    Ok(())
}

pub fn bite_exact(&mut self, amount: usize) -> Result<Bite<'_, T>, BiteError>

Takes exactly amount items or leaves the queue unchanged.

pub fn into_inner(self) -> VecDeque<T>

Consumes the wrapper and returns the underlying FIFO storage.

Trait Implementations

impl<T: Clone> Clone for BiteQueue<T>

fn clone(&self) -> BiteQueue<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BiteQueue<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for BiteQueue<T>

fn default() -> BiteQueue<T>

Returns the “default value” for a type.

impl<T: Eq> Eq for BiteQueue<T>

impl<T> Extend<T> for BiteQueue<T>

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> FromIterator<T> for BiteQueue<T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> IntoIterator for BiteQueue<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a BiteQueue<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for BiteQueue<T>

fn eq(&self, other: &BiteQueue<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for BiteQueue<T>