Skip to main content

LoggerConfigBuilder

nautilus_common::logging::config

Struct LoggerConfigBuilder 

Source 
pub struct LoggerConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

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

Implementations§

Source§

impl<S: State> LoggerConfigBuilder<S>

Source

pub fn build(self) -> LoggerConfig
where S: IsComplete,

Finish building and return the requested object

Source

pub fn stdout_level( self, value: LevelFilter, ) -> LoggerConfigBuilder<SetStdoutLevel<S>>
where S::StdoutLevel: IsUnset,

Optional (Some / Option setters). Default: LevelFilter::Info.

Maximum log level for stdout output.

Source

pub fn maybe_stdout_level( self, value: Option<LevelFilter>, ) -> LoggerConfigBuilder<SetStdoutLevel<S>>
where S::StdoutLevel: IsUnset,

Optional (Some / Option setters). Default: LevelFilter::Info.

Maximum log level for stdout output.

Source

pub fn fileout_level( self, value: LevelFilter, ) -> LoggerConfigBuilder<SetFileoutLevel<S>>
where S::FileoutLevel: IsUnset,

Optional (Some / Option setters). Default: LevelFilter::Off.

Maximum log level for file output (Off disables file logging).

Source

pub fn maybe_fileout_level( self, value: Option<LevelFilter>, ) -> LoggerConfigBuilder<SetFileoutLevel<S>>
where S::FileoutLevel: IsUnset,

Optional (Some / Option setters). Default: LevelFilter::Off.

Maximum log level for file output (Off disables file logging).

Source

pub fn component_level( self, value: AHashMap<Ustr, LevelFilter>, ) -> LoggerConfigBuilder<SetComponentLevel<S>>
where S::ComponentLevel: IsUnset,

Optional (Some / Option setters). Default: <AHashMap<Ustr, LevelFilter> as Default>::default().

Per-component log level overrides (exact match).

Source

pub fn maybe_component_level( self, value: Option<AHashMap<Ustr, LevelFilter>>, ) -> LoggerConfigBuilder<SetComponentLevel<S>>
where S::ComponentLevel: IsUnset,

Optional (Some / Option setters). Default: <AHashMap<Ustr, LevelFilter> as Default>::default().

Per-component log level overrides (exact match).

Source

pub fn module_level( self, value: AHashMap<Ustr, LevelFilter>, ) -> LoggerConfigBuilder<SetModuleLevel<S>>
where S::ModuleLevel: IsUnset,

Optional (Some / Option setters). Default: <AHashMap<Ustr, LevelFilter> as Default>::default().

Per-module path log level overrides (prefix match).

Source

pub fn maybe_module_level( self, value: Option<AHashMap<Ustr, LevelFilter>>, ) -> LoggerConfigBuilder<SetModuleLevel<S>>
where S::ModuleLevel: IsUnset,

Optional (Some / Option setters). Default: <AHashMap<Ustr, LevelFilter> as Default>::default().

Per-module path log level overrides (prefix match).

Source

pub fn log_components_only( self, value: bool, ) -> LoggerConfigBuilder<SetLogComponentsOnly<S>>
where S::LogComponentsOnly: IsUnset,

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

Log only components with explicit level filters.

Source

pub fn maybe_log_components_only( self, value: Option<bool>, ) -> LoggerConfigBuilder<SetLogComponentsOnly<S>>
where S::LogComponentsOnly: IsUnset,

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

Log only components with explicit level filters.

Source

pub fn is_colored(self, value: bool) -> LoggerConfigBuilder<SetIsColored<S>>
where S::IsColored: IsUnset,

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

Use ANSI color codes in output.

Source

pub fn maybe_is_colored( self, value: Option<bool>, ) -> LoggerConfigBuilder<SetIsColored<S>>
where S::IsColored: IsUnset,

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

Use ANSI color codes in output.

Source

pub fn print_config(self, value: bool) -> LoggerConfigBuilder<SetPrintConfig<S>>
where S::PrintConfig: IsUnset,

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

Print configuration to stdout at startup.

Source

pub fn maybe_print_config( self, value: Option<bool>, ) -> LoggerConfigBuilder<SetPrintConfig<S>>
where S::PrintConfig: IsUnset,

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

Print configuration to stdout at startup.

Source

pub fn use_tracing(self, value: bool) -> LoggerConfigBuilder<SetUseTracing<S>>
where S::UseTracing: IsUnset,

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

Initialize the tracing subscriber for external Rust crate logs.

Source

pub fn maybe_use_tracing( self, value: Option<bool>, ) -> LoggerConfigBuilder<SetUseTracing<S>>
where S::UseTracing: IsUnset,

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

Initialize the tracing subscriber for external Rust crate logs.

Source

pub fn bypass_logging( self, value: bool, ) -> LoggerConfigBuilder<SetBypassLogging<S>>
where S::BypassLogging: IsUnset,

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

If all logging should be bypassed.

Source

pub fn maybe_bypass_logging( self, value: Option<bool>, ) -> LoggerConfigBuilder<SetBypassLogging<S>>
where S::BypassLogging: IsUnset,

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

If all logging should be bypassed.

Source

pub fn file_config( self, value: FileWriterConfig, ) -> LoggerConfigBuilder<SetFileConfig<S>>
where S::FileConfig: IsUnset,

Optional (Some / Option setters). File writer configuration for log file output.

Source

pub fn maybe_file_config( self, value: Option<FileWriterConfig>, ) -> LoggerConfigBuilder<SetFileConfig<S>>
where S::FileConfig: IsUnset,

Optional (Some / Option setters). File writer configuration for log file output.

Source

pub fn clear_log_file( self, value: bool, ) -> LoggerConfigBuilder<SetClearLogFile<S>>
where S::ClearLogFile: IsUnset,

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

If the log file should be cleared before use.

Source

pub fn maybe_clear_log_file( self, value: Option<bool>, ) -> LoggerConfigBuilder<SetClearLogFile<S>>
where S::ClearLogFile: IsUnset,

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

If the log file should be cleared before use.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

§

impl<T> Ungil for T
where T: Send,