Struct Inbox 

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

A bounded FIFO receive queue with a default message TTL.

Items pushed without an explicit TTL use the default. Pass default_ttl_secs = 0 for items that never expire.

Examples

use ma_core::Inbox;

let mut inbox: Inbox<&str> = Inbox::new(64, 300);
let now = 1_000_000;
inbox.push(now, "hello");
assert_eq!(inbox.pop(now), Some("hello"));

// After the TTL expires, the message is gone:
inbox.push(now, "ephemeral");
assert_eq!(inbox.pop(now + 301), None);

Implementations

impl<T> Inbox<T>

pub fn new(capacity: usize, default_ttl_secs: u64) -> Self

Create an inbox with the given capacity and default TTL (seconds).

default_ttl_secs = 0 means items never expire by default.

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

Push an item using the default TTL.

pub fn push_with_ttl(&mut self, now: u64, ttl_secs: u64, item: T)

Push an item with a custom TTL (seconds). ttl_secs = 0 means no expiry.

pub fn pop(&mut self, now: u64) -> Option<T>

Pop the oldest non-expired item.

pub fn peek(&mut self, now: u64) -> Option<&T>

Peek at the oldest non-expired item.

pub fn drain(&mut self, now: u64) -> Vec<T>

Drain all non-expired items in FIFO order.

pub fn len(&self) -> usize

Number of items in the queue (may include not-yet-evicted expired items).

pub fn is_empty(&self) -> bool

Whether the queue is empty.

Trait Implementations

impl<T: Clone> Clone for Inbox<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Inbox<T>

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

Formats the value using the given formatter.