Struct QlogRecorder 

pub struct QlogRecorder { /* private fields */ }

Available on crate features quic and std only.

A cloneable handle to one worker. Clones share the destination and recording gate. Keep a handle to await completion; dropping it never waits for output.

Implementations

impl QlogRecorder

pub fn state(&self) -> RecorderState

Current task lifecycle; use Self::is_enabled to check the recording gate too.

pub fn is_enabled(&self) -> bool

Whether the recording gate is enabled and the task still accepts events. A true result does not guarantee available queue capacity.

pub fn set_enabled(&self, enabled: bool)

Change admission for all attached connections. Already submitted events still drain. Re-enabling records subsequent observations only; it does not recreate missed history or restart a closed or failed task.

pub fn stats(&self) -> RecorderStats

Read admission counters and current storage use without waiting for output. Concurrent activity can change individual fields while this snapshot is read.

pub fn error(&self) -> Option<Error>

The first published output or task failure, if any. Reading the error does not consume it or retry partially written records.

pub async fn flush(&self) -> Result<(), Error>

Wait until every event submitted before this command has been processed and output flushed. In history mode this retains events; use Self::dump_recent to write them. Also reports output initialization failure.

pub async fn shutdown(&self) -> Result<(), Error>

Close admission immediately, drain submitted events, finish and drop the destination. This waits asynchronously. Cancellation of the waiter does not cancel shutdown. Undumped history is discarded. All clones observe the same completion.

impl QlogRecorder

pub async fn dump_recent(&self, group: ConnectionId) -> Result<(), Error>

Write, consume and flush retained observations for the given connection group. Use the connection’s trace_id() when retaining a recorder inside composed sinks. Requires history recording; the request is ordered after previously submitted events. Cancelling the waiter does not retract a command already submitted to the task.

Trait Implementations

impl Clone for QlogRecorder

fn clone(&self) -> QlogRecorder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QlogRecorder

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

Formats the value using the given formatter.

impl QlogSink for QlogRecorder

fn is_enabled(&self) -> bool

Cheap gate checked before constructing a borrowed view. Defaults to enabled.

fn generation(&self) -> u64

Increment when recording selection changes to request a fresh recovery snapshot. Sinks with fixed selection may keep the default.

fn emit(&self, event: &QlogEventView<'_>) -> bool

Inspect an event without retaining its borrows.

fn filtered<F>(self, predicate: F) -> Filtered<Self, F>

where Self: Sized, F: Fn(&QlogEventView<'_>) -> bool + Send + Sync + 'static,

Select events without acquiring ownership. The predicate runs on the transport task and must also be cheap and nonblocking. For mutable selection state, use Self::filtered_by with a QlogFilter that advances its generation.

fn filtered_by<F>(self, predicate: F) -> Filtered<Self, F>

where F: QlogFilter, Self: Sized,

Wrap this sink with a filter whose generation reports dynamic selection changes.