Skip to main content

BoundedHistory

Struct BoundedHistory 

Source
pub struct BoundedHistory<T> { /* private fields */ }
Expand description

Count- and payload-bounded heap history of consumer-owned structured rows.

Oldest rows are evicted first. Iteration borrows immutable rows in append order and can be reversed for newest-first views. No Clone bound is needed. There is no clock, timestamp ordering, sequence identity, truncation, codec, checkpoint or global recorder. Consumers retain sanitization, field bounds, privacy, synchronization and lifecycle; this is not a durable byte format. Interior-mutability payloads must not grow their charged content while retained.

Implementations§

Source§

impl<T> BoundedHistory<T>

Source

pub const fn new(limits: HistoryLimits) -> Self

Construct an empty history without allocating.

Source

pub fn append( &mut self, value: T, payload_bytes: usize, ) -> Result<HistoryAppend, HistoryRejection<T>>

Append one pre-admitted payload, evicting oldest rows until both bounds fit.

Work is bounded by the configured retained row count. Payload charges are stored at admission and are not recomputed during eviction.

§Errors

Returns the original input when disabled or individually oversized. Refusal changes neither retained rows nor payload accounting.

Source

pub fn entries( &self, ) -> impl DoubleEndedIterator<Item = &T> + ExactSizeIterator + '_

Borrow rows oldest first; reverse the iterator for newest-first projection.

Source

pub const fn retained_payload_bytes(&self) -> usize

Current sum of caller-accounted retained payload bytes.

Source

pub const fn limits(&self) -> HistoryLimits

Immutable consumer-selected bounds.

Source

pub fn clear(&mut self)

Drop all retained rows and charges, preserving limits. This establishes no instance/reset identity.

Trait Implementations§

Source§

impl<T: Clone> Clone for BoundedHistory<T>

Source§

fn clone(&self) -> Self

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<T: Debug> Debug for BoundedHistory<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Forget for BoundedHistory<T>

§

impl<T> Freeze for BoundedHistory<T>
where VecDeque<Row<T>>: Freeze,

§

impl<T> Move for BoundedHistory<T>

§

impl<T> RefUnwindSafe for BoundedHistory<T>
where VecDeque<Row<T>>: RefUnwindSafe,

§

impl<T> Send for BoundedHistory<T>
where VecDeque<Row<T>>: Send,

§

impl<T> Sync for BoundedHistory<T>
where VecDeque<Row<T>>: Sync,

§

impl<T> Unpin for BoundedHistory<T>
where VecDeque<Row<T>>: Unpin,

§

impl<T> UnsafeUnpin for BoundedHistory<T>
where VecDeque<Row<T>>: UnsafeUnpin,

§

impl<T> UnwindSafe for BoundedHistory<T>
where VecDeque<Row<T>>: UnwindSafe,

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<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 = !

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

fn try_from(value: U) -> Result<T, !>

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.