Skip to main content

RingBufferChannel

Struct RingBufferChannel 

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

Ring buffer channel for append-heavy fields with bounded size

Wraps a Vec<T> with a maximum capacity. When new values are appended and the capacity is exceeded, the oldest elements are removed. This prevents unbounded memory growth for append-heavy fields like messages, events, and logs.

§Examples

use juncture_core::state::channel::RingBufferChannel;

let mut ch = RingBufferChannel::new(Vec::new(), 100);
ch.update(vec!["msg1".to_string(), "msg2".to_string()]);
assert_eq!(ch.get().len(), 2);

Implementations§

Source§

impl<T> RingBufferChannel<T>

Source

pub fn new(values: Vec<T>, capacity: usize) -> Self

Create a new ring buffer channel with the given initial values and capacity

The capacity is clamped to a minimum of 1. If values exceeds the capacity, the oldest elements are trimmed.

Source

pub const fn capacity(&self) -> usize

Get the current capacity

Source

pub fn len(&self) -> usize

Get the current number of elements

Source

pub fn is_empty(&self) -> bool

Check if the ring buffer is empty

Trait Implementations§

Source§

impl<T: Send + Sync + Serialize + DeserializeOwned + 'static> Channel<Vec<T>> for RingBufferChannel<T>

Source§

fn update(&mut self, values: Vec<Vec<T>>) -> bool

Update the channel with new values. Returns true if the value changed.
Source§

fn get(&self) -> &Vec<T>

Get the current value
Source§

fn consume(&mut self) -> bool

Check if the channel has been consumed (for trigger-based activation)
Source§

fn checkpoint(&self) -> Option<Value>

Create a checkpoint of the current value for persistence
Source§

fn from_checkpoint(value: Value) -> Result<Self, String>

Restore from a checkpoint value Read more
Source§

impl<T: Clone> Clone for RingBufferChannel<T>

Source§

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

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 RingBufferChannel<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for RingBufferChannel<T>

§

impl<T> RefUnwindSafe for RingBufferChannel<T>
where T: RefUnwindSafe,

§

impl<T> Send for RingBufferChannel<T>
where T: Send,

§

impl<T> Sync for RingBufferChannel<T>
where T: Sync,

§

impl<T> Unpin for RingBufferChannel<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for RingBufferChannel<T>

§

impl<T> UnwindSafe for RingBufferChannel<T>
where 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more