Skip to main content

LogBuffer

Struct LogBuffer 

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

Thread-safe, bounded ring buffer of timestamped log events.

Implementations§

Source§

impl LogBuffer

Source

pub fn new(capacity: usize, enabled: bool) -> Self

Create a new log buffer with the given capacity and enabled flag.

Source

pub fn is_enabled(&self) -> bool

Return whether logging is enabled.

Source

pub fn capacity(&self) -> usize

Return the configured capacity (maximum number of events).

Source

pub fn record(&self, direction: Option<&str>, event: LogEvent)

Record a typed event with an optional direction.

Source

pub fn snapshot(&self) -> Vec<LogEntry>

Return a snapshot of all entries in the buffer.

Source

pub fn jsonl_snapshot(&self, max_bytes: u64) -> Result<JsonlSnapshot, String>

Serialize the buffer to a bounded JSONL snapshot.

Locks the log exactly once for a consistent point-in-time snapshot, serializes one entry per line with a trailing newline, and checks the projected size before extending the output (checked arithmetic). Fails — leaving no output — when the exact snapshot exceeds max_bytes (the capture per-file quota). The event deque itself is never cloned and no second full output String is built.

Source

pub fn clear(&self)

Clear all entries from the buffer.

Source§

impl LogBuffer

Typed wrapper to share across the server.

Source

pub fn new_shared(capacity: usize, enabled: bool) -> Arc<Self> ⓘ

Source§

impl LogBuffer

Source

pub fn rx_data(&self, bytes: usize)

Source

pub fn tx_data(&self, bytes: usize)

Source

pub fn opened(&self)

Source

pub fn closed(&self)

Source

pub fn match_found(&self, pattern: &str, mode: &str)

Source

pub fn truncated(&self, observed: usize, returned: usize)

Trait Implementations§

Source§

impl Debug for LogBuffer

Source§

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

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

impl Default for LogBuffer

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> 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, 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.
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