Struct BoundedQueue 

pub struct BoundedQueue { /* private fields */ }

Bounded message queue

A queue with a fixed maximum capacity and configurable overflow policy.

Example

use canlink_hal::queue::{BoundedQueue, QueueOverflowPolicy};
use canlink_hal::message::CanMessage;

// Create queue with default policy (DropOldest)
let mut queue = BoundedQueue::new(100);

// Create queue with custom policy
let mut queue = BoundedQueue::with_policy(100, QueueOverflowPolicy::DropNewest);

Implementations

impl BoundedQueue

pub fn new(capacity: usize) -> Self

Create a new bounded queue with default overflow policy

Arguments

• capacity - Maximum number of messages the queue can hold

Example

use canlink_hal::queue::BoundedQueue;

let queue = BoundedQueue::new(1000);
assert_eq!(queue.capacity(), 1000);

pub fn with_policy(capacity: usize, policy: QueueOverflowPolicy) -> Self

Create a new bounded queue with specified overflow policy

Arguments

• capacity - Maximum number of messages the queue can hold
• policy - Overflow handling policy

pub fn capacity(&self) -> usize

Get the queue capacity

pub fn len(&self) -> usize

Get the current number of messages in the queue

pub fn is_empty(&self) -> bool

Check if the queue is empty

pub fn is_full(&self) -> bool

Check if the queue is full

pub fn policy(&self) -> QueueOverflowPolicy

Get the overflow policy

pub fn stats(&self) -> QueueStats

Get queue statistics

pub fn push(&mut self, message: CanMessage) -> Result<(), QueueError>

Push a message to the queue

Behavior depends on the overflow policy:

• DropOldest: Removes the oldest message if full
• DropNewest: Rejects the new message if full
• Block: Returns QueueError::QueueFull (async version handles blocking)

Errors

• Returns QueueError::QueueFull if using Block policy and queue is full
• Returns QueueError::MessageDropped if using DropNewest policy and queue is full

pub fn pop(&mut self) -> Option<CanMessage>

Pop a message from the queue

Returns None if the queue is empty.

pub fn peek(&self) -> Option<&CanMessage>

Peek at the next message without removing it

pub fn clear(&mut self)

Clear all messages from the queue

pub fn adjust_capacity(&mut self, new_capacity: usize)

Adjust the queue capacity

If the new capacity is smaller than the current number of messages, excess messages are removed according to the overflow policy.

Arguments

• new_capacity - New maximum capacity

pub fn iter(&self) -> impl Iterator<Item = &CanMessage>

Iterate over messages without removing them

impl BoundedQueue

pub fn from_config(config: &QueueConfig) -> Self

Create a BoundedQueue from configuration

Trait Implementations

impl Default for BoundedQueue

fn default() -> Self

Returns the “default value” for a type.