Struct Bite 

pub struct Bite<'a, T> { /* private fields */ }

A borrowed, transactional prefix of a BiteQueue.

The source queue stays exclusively borrowed until this value is committed, explicitly rolled back, or dropped.

Implementations

impl<T> Bite<'_, T>

pub fn len(&self) -> usize

Number of items in this bite.

pub fn is_empty(&self) -> bool

Returns whether this bite contains no items.

A bite from an empty queue can be empty even though its requested maximum was non-zero.

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

First item in this bite.

Examples found in repository

examples/worker.rs (line 11)

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 iter(&self) -> impl ExactSizeIterator<Item = &T> + DoubleEndedIterator

Iterates over the bite in original FIFO order.

pub fn commit(self) -> Vec<T>

Commits the bite and returns its items in FIFO order.

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 rollback(self)

Explicitly restores the bite to the queue.

Dropping without calling either commit or rollback has the same restoration behavior.

Trait Implementations

impl<T: Debug> Debug for Bite<'_, T>

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

Formats the value using the given formatter.

impl<T> Drop for Bite<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a, T> IntoIterator for &'a Bite<'_, 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.