Skip to main content

LogBuffer

Struct LogBuffer 

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

Thread-safe, bounded ring buffer of formatted log lines.

Why: shared between the tracing Layer (writer) and the HTTP handler (reader); both hold cheap Arc clones of the same underlying deque. What: wraps Arc<Mutex<VecDeque<String>>>. push appends and evicts the oldest line past capacity; tail snapshots the most recent N lines. Test: capacity_evicts_oldest, tail_returns_last_n.

Implementations§

Source§

impl LogBuffer

Source

pub fn new(capacity: usize) -> Self

Create an empty buffer with the given line capacity.

Why: callers (daemon startup) choose the cap; tests use a tiny one. What: allocates a VecDeque with capacity.max(1) reserved slots so a zero capacity is treated as one (a zero-cap ring is useless and would panic on the eviction arithmetic). Test: capacity_evicts_oldest.

Source

pub fn push(&self, line: String)

Append a line, evicting the oldest entry when at capacity.

Why: a tracing Layer calls this on every event; it must never panic or block long. A poisoned mutex (a prior panic while logging) is recovered via into_inner so logging itself never cascades a panic into the daemon. What: pushes line to the back; if length now exceeds capacity, pops the front. Test: capacity_evicts_oldest.

Source

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

Snapshot the most recent n lines (or all, when n exceeds the current length).

Why: the /logs/tail handler returns these as a JSON array. Cloning under the lock keeps the critical section short and lets the caller serialise without holding the mutex. What: returns a Vec<String> of at most n lines, oldest-first. Test: tail_returns_last_n, tail_all_when_n_exceeds_len.

Source

pub fn len(&self) -> usize

Total number of lines currently buffered.

Why: the /logs/tail response reports total so callers can tell whether the buffer has wrapped. What: returns the deque length. Test: tail_returns_last_n asserts len after pushes.

Source

pub fn is_empty(&self) -> bool

Whether the buffer holds no lines.

Why: clippy requires is_empty alongside len; also a convenient readiness check in tests. What: returns len() == 0. Test: covered by capacity_evicts_oldest.

Trait Implementations§

Source§

impl Clone for LogBuffer

Source§

fn clone(&self) -> LogBuffer

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 Debug for LogBuffer

Source§

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

Formats the value using the given formatter. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<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