Struct Spool 

pub struct Spool { /* private fields */ }

Available on crate feature spool only.

Disk-backed async FIFO queue with optional compression.

Crash-safe writes, survives restarts. Built on yaque (transactional persistent queue).

Implementations

impl Spool

pub async fn open(config: SpoolConfig) -> Result<Self>

Open the queue at the configured path, creating it if absent.

Errors

Returns an error if the queue cannot be opened or created.

pub async fn create(path: impl AsRef<Path>) -> Result<Self>

Create a new spool at the given path with default settings.

Errors

Returns an error if the queue cannot be created.

pub async fn create_compressed(path: impl AsRef<Path>) -> Result<Self>

Create a new spool with compression enabled.

Errors

Returns an error if the queue cannot be created.

pub async fn push(&mut self, data: &[u8]) -> Result<()>

Push data onto the queue, compressing first if enabled.

Errors

Errors on size/item-count cap, compression failure, or I/O.

pub async fn peek(&mut self) -> Result<Option<Vec<u8>>>

Peek at the first item without removing it.

yaque has no direct peek – try_recv then let the guard roll back on drop to leave the item in the queue.

Errors

Returns an error if decompression fails or an I/O error occurs.

pub async fn pop(&mut self) -> Result<()>

Remove the first item from the queue.

Errors

Returns an error if an I/O error occurs.

pub async fn pop_front(&mut self) -> Result<Option<Vec<u8>>>

Pop and return the first item, atomically receiving and removing it.

Errors

Returns an error if decompression fails or an I/O error occurs.

pub async fn recv(&mut self) -> Result<Vec<u8>>

Receive an item, awaiting if the queue is empty. Preferred consumer API.

Errors

Returns an error if decompression fails or an I/O error occurs.

pub fn len(&self) -> usize

Approximate item count, tracked internally.

pub fn is_empty(&self) -> bool

Check if the queue is empty.

pub fn clear(&mut self) -> Result<()>

Drain all items from the queue.

Errors

Returns an error if an I/O error occurs.

pub fn config(&self) -> &SpoolConfig

Get the configuration for this spool.

pub fn file_size(&self) -> Result<u64>

Get the approximate directory size in bytes.

Errors

Returns an error if the directory cannot be read.

Trait Implementations

impl Debug for Spool

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

Formats the value using the given formatter.