Struct QlogConfig 

pub struct QlogConfig { /* private fields */ }

Available on crate features quic and std only.

Configure a worker and destination. The default has no destination and records nothing. Built-in output uses qlog main draft 14 / QUIC events draft 13 JSON text sequences. See qlog for specification links and reader compatibility. Supply an output for custom storage, or an EncodedWriter for a custom serializer.

Implementations

impl QlogConfig

pub fn with_writer( self, writer: impl AsyncWrite + Unpin + Send + 'static, ) -> QlogConfig

Asynchronous destination for JSON text sequences, buffered with an 8 KiB buffer. Flush and shutdown drain the buffer. Use output with an EncodedWriter to control buffering explicitly or use a custom encoder.

pub fn set_writer( &mut self, writer: impl AsyncWrite + Unpin + Send + 'static, ) -> &mut QlogConfig

Asynchronous destination for JSON text sequences, buffered with an 8 KiB buffer. Flush and shutdown drain the buffer. Use output with an EncodedWriter to control buffering explicitly or use a custom encoder.

pub fn with_output(self, output: impl QlogOutput) -> QlogConfig

Custom asynchronous output, owned and invoked by the recording task.

pub fn set_output(&mut self, output: impl QlogOutput) -> &mut QlogConfig

Custom asynchronous output, owned and invoked by the recording task.

pub fn maybe_with_title(self, title: Option<ArcStr>) -> QlogConfig

Trace label. Use Rama’s arcstr! for allocation-free static text.

pub fn maybe_set_title(&mut self, title: Option<ArcStr>) -> &mut QlogConfig

Trace label. Use Rama’s arcstr! for allocation-free static text.

pub fn with_title(self, title: ArcStr) -> QlogConfig

Trace label. Use Rama’s arcstr! for allocation-free static text.

pub fn set_title(&mut self, title: ArcStr) -> &mut QlogConfig

Trace label. Use Rama’s arcstr! for allocation-free static text.

pub fn without_title(self) -> QlogConfig

Trace label. Use Rama’s arcstr! for allocation-free static text.

pub fn unset_title(&mut self) -> &mut QlogConfig

Trace label. Use Rama’s arcstr! for allocation-free static text.

pub fn maybe_with_description(self, description: Option<ArcStr>) -> QlogConfig

Optional trace context. Runtime text converts into shared ArcStr storage.

pub fn maybe_set_description( &mut self, description: Option<ArcStr>, ) -> &mut QlogConfig

Optional trace context. Runtime text converts into shared ArcStr storage.

pub fn with_description(self, description: ArcStr) -> QlogConfig

Optional trace context. Runtime text converts into shared ArcStr storage.

pub fn set_description(&mut self, description: ArcStr) -> &mut QlogConfig

Optional trace context. Runtime text converts into shared ArcStr storage.

pub fn without_description(self) -> QlogConfig

Optional trace context. Runtime text converts into shared ArcStr storage.

pub fn unset_description(&mut self) -> &mut QlogConfig

Optional trace context. Runtime text converts into shared ArcStr storage.

pub fn with_start_time(self, start_time: Instant) -> QlogConfig

Monotonic reference point for event timestamps.

pub fn set_start_time(&mut self, start_time: Instant) -> &mut QlogConfig

Monotonic reference point for event timestamps.

pub fn with_queue_limits(self, limits: QueueLimits) -> QlogConfig

Configure bounded admission. Invalid limits are rejected by start.

pub fn set_queue_limits(&mut self, limits: QueueLimits) -> &mut QlogConfig

Configure bounded admission. Invalid limits are rejected by start.

pub fn maybe_with_history(self, history: Option<HistoryConfig>) -> QlogConfig

Retain recent history instead of writing each observation immediately.

pub fn maybe_set_history( &mut self, history: Option<HistoryConfig>, ) -> &mut QlogConfig

Retain recent history instead of writing each observation immediately.

pub fn with_history(self, history: HistoryConfig) -> QlogConfig

Retain recent history instead of writing each observation immediately.

pub fn set_history(&mut self, history: HistoryConfig) -> &mut QlogConfig

Retain recent history instead of writing each observation immediately.

pub fn without_history(self) -> QlogConfig

Retain recent history instead of writing each observation immediately.

pub fn unset_history(&mut self) -> &mut QlogConfig

Retain recent history instead of writing each observation immediately.

pub fn with_enabled(self, enabled: bool) -> QlogConfig

Initial recording gate. A disabled recorder still initializes its destination.

pub fn set_enabled(&mut self, enabled: bool) -> &mut QlogConfig

Initial recording gate. A disabled recorder still initializes its destination.

pub fn with_executor(self, executor: Executor) -> QlogConfig

Executor for the recording task. A graceful executor closes admission on shutdown, then waits for accepted events and output finalization, including writer shutdown.

pub fn set_executor(&mut self, executor: Executor) -> &mut QlogConfig

Executor for the recording task. A graceful executor closes admission on shutdown, then waits for accepted events and output finalization, including writer shutdown.

pub fn with_error_sink(self, error_sink: impl ErrorSink) -> QlogConfig

Observe the first terminal output or recording-task failure, including graceful shutdown and runtime cancellation. Defaults to TracingErrorSink::default. The sink receives a rama_core::error::BoxError retaining the original cause. It runs outside recorder locks and must return promptly; offload slow work. Sink panics are isolated. Explicit flush and shutdown still return the failure.

pub fn set_error_sink(&mut self, error_sink: impl ErrorSink) -> &mut QlogConfig

Observe the first terminal output or recording-task failure, including graceful shutdown and runtime cancellation. Defaults to TracingErrorSink::default. The sink receives a rama_core::error::BoxError retaining the original cause. It runs outside recorder locks and must return promptly; offload slow work. Sink panics are isolated. Explicit flush and shutdown still return the failure.

pub fn start(self) -> Result<QlogRecorder, Error>

Start a task on the current Rama/Tokio runtime. Await flush to observe destination initialization. Submitting observations afterwards requires no runtime on the caller.

Trait Implementations

impl Default for QlogConfig

fn default() -> QlogConfig

Returns the “default value” for a type.