Skip to main content

InitOptions

Struct InitOptions 

Source
pub struct InitOptions { /* private fields */ }
Expand description

Configuration for init_with.

Constructed via InitOptions::default and the with_* builder methods. Each method consumes self and returns Self to support chaining:

use kamu_logging::{init_with, Format, InitOptions, Sink};

init_with(
    InitOptions::default()
        .with_service_name("my-service")
        .with_format(Format::Json)
        .with_sink(Sink::Stdout),
)?;

Implementations§

Source§

impl InitOptions

Source

pub fn with_service_name(self, name: impl Into<String>) -> Self

Attach a service.name field to every event. Used by log aggregators to route logs across services.

Source

pub fn with_default_filter(self, filter: impl Into<String>) -> Self

Default filter directive when the env var is unset. Defaults to "debug" in debug builds and "info" in release builds.

Source

pub fn with_env_var(self, var: impl Into<String>) -> Self

Environment variable read for the filter directive. Defaults to "RUST_LOG". Useful for per-binary triggers like "KKP_LOG" to avoid collisions with other tools’ RUST_LOG settings.

Source

pub fn with_format(self, format: Format) -> Self

Output format. See Format.

Source

pub fn with_sink(self, sink: Sink) -> Self

Output sink. See Sink.

Source

pub fn idempotent(self, enabled: bool) -> Self

When true, a second init_with call returns Ok(()) instead of Error::TracingGlobal.

Default is false so library double-init surfaces as an error. Set true from test harnesses and embedded CLI runs where re-init is expected.

Trait Implementations§

Source§

impl Clone for InitOptions

Source§

fn clone(&self) -> InitOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InitOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for InitOptions

Source§

fn default() -> InitOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more