Struct BackgroundTaskConfigBuilder 

pub struct BackgroundTaskConfigBuilder<S: State = Empty> { /* private fields */ }

Available on crate feature pipeline only.

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S: State> BackgroundTaskConfigBuilder<S>

pub fn build(self) -> BackgroundTaskConfig

where S: IsComplete,

Finish building and return the requested object

pub fn trace_dir( self, value: impl Into<PathBuf>, ) -> BackgroundTaskConfigBuilder<SetTraceDir<S>>

where S::TraceDir: IsUnset,

Optional (Some / Option setters). Directory holding the trace segments. None for the in-memory backend.

pub fn maybe_trace_dir( self, value: Option<impl Into<PathBuf>>, ) -> BackgroundTaskConfigBuilder<SetTraceDir<S>>

where S::TraceDir: IsUnset,

Optional (Some / Option setters). Directory holding the trace segments. None for the in-memory backend.

pub fn trace_stem( self, value: impl Into<String>, ) -> BackgroundTaskConfigBuilder<SetTraceStem<S>>

where S::TraceStem: IsUnset,

Optional (Some / Option setters). Segment filename stem (e.g. trace). None for the in-memory backend.

pub fn maybe_trace_stem( self, value: Option<impl Into<String>>, ) -> BackgroundTaskConfigBuilder<SetTraceStem<S>>

where S::TraceStem: IsUnset,

Optional (Some / Option setters). Segment filename stem (e.g. trace). None for the in-memory backend.

pub fn poll_interval( self, value: Duration, ) -> BackgroundTaskConfigBuilder<SetPollInterval<S>>

where S::PollInterval: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_POLL_INTERVAL.

How often the worker checks for sealed segments. Defaults to 1 second.

pub fn maybe_poll_interval( self, value: Option<Duration>, ) -> BackgroundTaskConfigBuilder<SetPollInterval<S>>

where S::PollInterval: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_POLL_INTERVAL.

How often the worker checks for sealed segments. Defaults to 1 second.

pub fn processors( self, value: Vec<Box<dyn SegmentProcessor>>, ) -> BackgroundTaskConfigBuilder<SetProcessors<S>>

where S::Processors: IsUnset,

Optional (Some / Option setters). Default: <Vec<Box<dyn SegmentProcessor>> as Default>::default().

The processor pipeline executed for each sealed segment, in order.

pub fn maybe_processors( self, value: Option<Vec<Box<dyn SegmentProcessor>>>, ) -> BackgroundTaskConfigBuilder<SetProcessors<S>>

where S::Processors: IsUnset,

Optional (Some / Option setters). Default: <Vec<Box<dyn SegmentProcessor>> as Default>::default().

The processor pipeline executed for each sealed segment, in order.

pub fn metrics_sink( self, value: BoxEntrySink, ) -> BackgroundTaskConfigBuilder<SetMetricsSink<S>>

where S::MetricsSink: IsUnset,

Optional (Some / Option setters). Default: metrique::writer::sink::DevNullSink::boxed().

Metrics sink. Defaults to DevNullSink.

pub fn maybe_metrics_sink( self, value: Option<BoxEntrySink>, ) -> BackgroundTaskConfigBuilder<SetMetricsSink<S>>

where S::MetricsSink: IsUnset,

Optional (Some / Option setters). Default: metrique::writer::sink::DevNullSink::boxed().

Metrics sink. Defaults to DevNullSink.

pub fn trigger( self, value: DumpRx, ) -> BackgroundTaskConfigBuilder<SetTrigger<S>>

where S::Trigger: IsUnset,

Optional (Some / Option setters). On-demand dump trigger receiver. When present the worker runs in triggered mode (see crate::dump): segments accumulate in the ring and the pipeline only runs on an explicit dump request. Wired by the facade builder; absent for continuous processing.

pub fn maybe_trigger( self, value: Option<DumpRx>, ) -> BackgroundTaskConfigBuilder<SetTrigger<S>>

where S::Trigger: IsUnset,

Optional (Some / Option setters). On-demand dump trigger receiver. When present the worker runs in triggered mode (see crate::dump): segments accumulate in the ring and the pipeline only runs on an explicit dump request. Wired by the facade builder; absent for continuous processing.