Skip to main content

ClientRingBuffer

Struct ClientRingBuffer 

Source
pub struct ClientRingBuffer { /* private fields */ }
Expand description

Per-client debug ring buffer.

A fixed-capacity (8 KB default) ring buffer that captures client-specific events for debugging. When the buffer is full, oldest entries are discarded.

§Thread Safety

All operations are thread-safe. Multiple readers can access the buffer simultaneously; writers are exclusive.

Implementations§

Source§

impl ClientRingBuffer

Source

pub fn new() -> Self

Creates a new ring buffer with default capacity (8 KB).

Source

pub fn with_capacity(capacity_bytes: usize) -> Self

Creates a new ring buffer with the specified capacity in bytes.

Source

pub fn log_event(&self, event_type: ClientEventType, details: impl Into<String>)

Logs an event to the buffer.

If the buffer would exceed capacity, oldest entries are discarded.

Source

pub fn log_key(&self, key: &str)

Logs a key press event.

Source

pub fn log_command(&self, command: &str)

Logs a command execution event.

Source

pub fn log_mode_change(&self, from: &str, to: &str)

Logs a mode change event.

Source

pub fn log_state_change(&self, description: &str)

Logs a state change event.

Source

pub fn log_error(&self, error: &str)

Logs an error event.

Source

pub fn tail(&self, n: usize) -> Vec<ClientLogEntry>

Returns the N most recent entries (newest first).

Source

pub fn entries(&self) -> Vec<ClientLogEntry>

Returns all entries in order (oldest to newest).

Source

pub fn dump(&self) -> String

Formats all entries as a string for crash dumps.

Blocks until the lock is acquired.

Source

pub fn try_dump(&self) -> Option<String>

Attempts to format all entries without blocking.

Returns None if the lock cannot be acquired immediately. Use this in panic handlers to avoid deadlocks.

Source

pub fn stats(&self) -> ClientBufferStats

Returns buffer statistics.

Source

pub fn bytes_used(&self) -> usize

Returns the current byte usage.

Source

pub fn clear(&self)

Clears all entries from the buffer.

Trait Implementations§

Source§

impl Clone for ClientRingBuffer

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClientRingBuffer

Source§

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

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

impl Default for ClientRingBuffer

Source§

fn default() -> Self

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

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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