Skip to main content

QueueOverflowPolicy

Enum QueueOverflowPolicy 

Source
pub enum QueueOverflowPolicy {
    DropOldest,
    DropNewest,
    Block {
        timeout: Duration,
    },
}
Expand description

Queue overflow handling policy

Determines how the queue behaves when it reaches capacity.

§Default

The default policy is DropOldest, which is suitable for real-time monitoring scenarios where the latest data is most important.

§Example

use canlink_hal::queue::QueueOverflowPolicy;
use std::time::Duration;

// Default policy
let policy = QueueOverflowPolicy::default();
assert!(matches!(policy, QueueOverflowPolicy::DropOldest));

// Block with timeout
let policy = QueueOverflowPolicy::Block {
    timeout: Duration::from_millis(100),
};

Variants§

§

DropOldest

Drop the oldest message in the queue

This is the default policy, suitable for real-time monitoring where the latest data is most important.

§

DropNewest

Drop the newest message (the one being added)

Suitable for data recording scenarios where preserving complete history is important.

§

Block

Block until space is available or timeout expires

Suitable for critical messages that should not be lost. Returns QueueError::QueueFull if timeout expires.

Fields

§timeout: Duration

Maximum time to wait for space

Implementations§

Source§

impl QueueOverflowPolicy

Source

pub fn drop_oldest() -> Self

Create a new DropOldest policy

Source

pub fn drop_newest() -> Self

Create a new DropNewest policy

Source

pub fn block(timeout: Duration) -> Self

Create a new Block policy with the given timeout

Source

pub fn may_block(&self) -> bool

Check if this policy may block

Source

pub fn timeout(&self) -> Option<Duration>

Get the timeout if this is a Block policy

Trait Implementations§

Source§

impl Clone for QueueOverflowPolicy

Source§

fn clone(&self) -> QueueOverflowPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for QueueOverflowPolicy

Source§

impl Debug for QueueOverflowPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QueueOverflowPolicy

Source§

fn default() -> QueueOverflowPolicy

Returns the “default value” for a type. Read more
Source§

impl Eq for QueueOverflowPolicy

Source§

impl PartialEq for QueueOverflowPolicy

Source§

fn eq(&self, other: &QueueOverflowPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for QueueOverflowPolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.