Struct RuntimeObservationHandle 

pub struct RuntimeObservationHandle { /* private fields */ }

Cheaply cloneable recording capability without terminal-seal authority.

Implementations

impl RuntimeObservationHandle

pub const fn disabled() -> Self

Returns a disabled session.

pub const fn config(&self) -> RuntimeObservationConfig

Returns the immutable recorder configuration.

pub fn query_id(&self) -> Option<&QueryId>

Returns the immutable query identity when recording is enabled.

pub fn trace_id(&self) -> Option<&TraceId>

Returns the immutable optional parent trace identity.

pub fn source_location_id(&self, value: &str) -> Option<RuntimeSourceLocationId>

Returns a keyed, query-scoped source-location identity when recording is enabled.

pub fn record<F>(&self, build_payload: F) -> RuntimeObservationRecordDisposition

where F: FnOnce() -> RuntimeObservationPayload,

Lazily constructs and records a query-level event.

pub fn record_for_plan<F>( &self, plan_execution_id: PlanExecutionId, build_payload: F, ) -> RuntimeObservationRecordDisposition

where F: FnOnce() -> RuntimeObservationPayload,

Lazily constructs and records an event for one plan execution.

pub fn record_with_context<F>( &self, context: RuntimeEventContext, build_payload: F, ) -> RuntimeObservationRecordDisposition

where F: FnOnce() -> RuntimeObservationPayload,

Lazily constructs an event before acquiring recorder order and records it infallibly.

pub fn record_topology<F>( &self, class: RuntimeObservationRecordClass, build_record: F, ) -> RuntimeObservationRecordDisposition

where F: FnOnce() -> RuntimeTopologyRecord,

Lazily constructs and records one static topology row.

pub fn live_snapshot(&self) -> Option<LiveRuntimeObservationSnapshot>

Captures an immutable incomplete view. Returns none after sealing or when disabled.

pub fn sealed_snapshot(&self) -> Option<SealedRuntimeObservationSnapshot>

Returns the sealed immutable snapshot when a terminal outcome was already fixed.

pub fn record_source_read( &self, plan_execution_id: &PlanExecutionId, fact: SourceReadFact, )

Folds one source-read fact into a plan execution’s exact totals.

This runs whether or not trace capture is enabled, and before any retention decision, so the totals never depend on what was retained. Facts arriving after the owner sealed are ignored.

pub fn record_source_read_row( &self, plan_execution_id: &PlanExecutionId, row: SourceReadRuntimeMetrics, )

Offers one source-read detail row for bounded retention.

Rows never feed totals; record the matching SourceReadFacts for those. With trace capture disabled the row is intentionally not kept; otherwise it is retained under the recorder’s record and byte limits, which are shared by the whole query, and a declined row is counted as a SourceReadDetail loss.

pub fn metrics_checkpoint( &self, plan_execution_id: &PlanExecutionId, ) -> Option<QueryMetricsCheckpoint>

Returns one internally consistent view of a plan execution’s metrics.

Available for any query-bound session, including one whose trace capture is disabled. A plan execution that recorded nothing yet reports empty totals. Returns None only for Self::disabled.

Trait Implementations

impl Clone for RuntimeObservationHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeObservationHandle

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

Formats the value using the given formatter.

impl Default for RuntimeObservationHandle

fn default() -> Self

Returns the “default value” for a type.