Struct Dial9ConfigBuilder 

pub struct Dial9ConfigBuilder<S = Empty>
where
    S: State,
{ /* private fields */ }

Available on crate feature dial9 only.

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

Implementations

impl<S> Dial9ConfigBuilder<S>

where S: State,

pub fn build(self) -> Result<Dial9Config, Dial9ConfigBuilderError>

where S: IsComplete,

Finishes building and performs the requested action.

pub fn enabled(self, value: bool) -> Dial9ConfigBuilder<SetEnabled<S>>

where <S as State>::Enabled: IsUnset,

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

Defaults to true. When false, required writer fields are ignored and the runtime is built without telemetry.

pub fn maybe_enabled( self, value: Option<bool>, ) -> Dial9ConfigBuilder<SetEnabled<S>>

where <S as State>::Enabled: IsUnset,

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

Defaults to true. When false, required writer fields are ignored and the runtime is built without telemetry.

pub fn base_path( self, value: impl Into<PathBuf>, ) -> Dial9ConfigBuilder<SetBasePath<S>>

where <S as State>::BasePath: IsUnset,

Optional (Some / Option setters). Trace output path.

pub fn maybe_base_path( self, value: Option<impl Into<PathBuf>>, ) -> Dial9ConfigBuilder<SetBasePath<S>>

where <S as State>::BasePath: IsUnset,

Optional (Some / Option setters). Trace output path.

pub fn max_file_size(self, value: u64) -> Dial9ConfigBuilder<SetMaxFileSize<S>>

where <S as State>::MaxFileSize: IsUnset,

Optional (Some / Option setters). Per-file rotation threshold in bytes.

pub fn maybe_max_file_size( self, value: Option<u64>, ) -> Dial9ConfigBuilder<SetMaxFileSize<S>>

where <S as State>::MaxFileSize: IsUnset,

Optional (Some / Option setters). Per-file rotation threshold in bytes.

pub fn max_total_size( self, value: u64, ) -> Dial9ConfigBuilder<SetMaxTotalSize<S>>

where <S as State>::MaxTotalSize: IsUnset,

Optional (Some / Option setters). Total disk budget in bytes.

pub fn maybe_max_total_size( self, value: Option<u64>, ) -> Dial9ConfigBuilder<SetMaxTotalSize<S>>

where <S as State>::MaxTotalSize: IsUnset,

Optional (Some / Option setters). Total disk budget in bytes.

pub fn rotation_period( self, value: Duration, ) -> Dial9ConfigBuilder<SetRotationPeriod<S>>

where <S as State>::RotationPeriod: IsUnset,

Optional (Some / Option setters). Rotation period for the writer, measured monotonically from writer (or last-rotation) start.

pub fn maybe_rotation_period( self, value: Option<Duration>, ) -> Dial9ConfigBuilder<SetRotationPeriod<S>>

where <S as State>::RotationPeriod: IsUnset,

Optional (Some / Option setters). Rotation period for the writer, measured monotonically from writer (or last-rotation) start.

impl<S> Dial9ConfigBuilder<S>

where S: State,

pub fn with_tokio<F>(self, f: F) -> Dial9ConfigBuilder<S>

where F: Fn(&mut Builder) + Send + Sync + 'static,

Queue a configurator for the underlying [tokio::runtime::Builder].

The closure receives a fresh builder by mutable reference — use any tokio knob (worker_threads, thread_name, thread_stack_size, global_queue_interval, etc.). The builder is pre-seeded with new_multi_thread() and enable_all(). To switch flavors, replace the whole builder inside the closure: *t = tokio::runtime::Builder::new_current_thread(); t.enable_all();.

Can be called multiple times; configurators are applied in call order each time the runtime is materialized. The closure must be Fn + Send + Sync + 'static so that build_or_disabled can preserve the configurators on the disabled-fallback variant.

Warning

Setting any of the 8 Tokio runtime hooks (on_thread_start, on_thread_stop, on_thread_park, on_thread_unpark, on_task_spawn, on_task_terminate, on_before_task_poll, on_after_task_poll) via this closure will be silently overwritten by dial9’s internal hooks. Use with_runtime + TracedRuntimeBuilder::with_tokio_hooks to compose user callbacks with dial9’s hooks instead.

pub fn with_runtime<F, N>(self, f: F) -> Dial9ConfigBuilder<S>

where F: FnOnce(TracedRuntimeBuilder<HasTracePath>) -> TracedRuntimeBuilder<HasTracePath, N> + 'static, N: Send + 'static,

Set the configurator for the dial9 TracedRuntimeBuilder.

The closure receives the staged builder by value and must return it. Use this to access runtime configuration methods like with_runtime_name, with_task_tracking, with_s3_uploader, or with_custom_pipeline; see TracedRuntimeBuilder for the full list.

The closure may transition the builder’s pipeline-mode marker (e.g. by calling .with_s3_uploader(...) or .with_custom_pipeline(...)); the resulting mode is preserved through to runtime construction.

The configurator is applied during build() once base_path is known. When .enabled(false) is set the configurator is ignored. Calling this method more than once replaces the prior closure.

impl<S> Dial9ConfigBuilder<S>

where S: IsComplete,

pub fn build_or_disabled(self) -> Dial9Config

Finish into a Dial9Config that never reports a build error.

On any Dial9ConfigBuilderError (validation failure or writer I/O probe failure) logs an error and returns a Dial9Config in its disabled state with the user’s with_tokio configurators preserved. The resulting config builds a plain tokio runtime when handed to crate::TracedRuntime::try_new.

Panics (debug builds only)

Panics on missing required fields to surface misconfigurations during development.

Lenient counterpart to build. Use build instead when you want validation and writer-I/O failures to surface as Dial9ConfigBuilderError.