Struct LoggerConfig 

pub struct LoggerConfig {

    pub stdout_level: LevelFilter,
    pub fileout_level: LevelFilter,
    pub component_level: AHashMap<Ustr, LevelFilter>,
    pub module_level: AHashMap<Ustr, LevelFilter>,
    pub log_components_only: bool,
    pub is_colored: bool,
    pub print_config: bool,
    pub use_tracing: bool,
    pub bypass_logging: bool,
    pub file_config: Option<FileWriterConfig>,
    pub clear_log_file: bool,
    pub fileout_sync_on_flush: bool,
    pub buffered_stdout: bool,
}

Configuration for the Nautilus logger.

Fields

stdout_level: LevelFilter

Maximum log level for stdout output.

fileout_level: LevelFilter

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

component_level: AHashMap<Ustr, LevelFilter>

Per-component log level overrides (exact match).

module_level: AHashMap<Ustr, LevelFilter>

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

log_components_only: bool

Log only components with explicit level filters.

is_colored: bool

Use ANSI color codes in output.

print_config: bool

Print configuration to stdout at startup.

use_tracing: bool

Initialize the tracing subscriber for external Rust crate logs.

bypass_logging: bool

If all logging should be bypassed.

file_config: Option<FileWriterConfig>

File writer configuration for log file output.

clear_log_file: bool

If the log file should be cleared before use.

fileout_sync_on_flush: bool

If file log flushes should also sync data to disk.

buffered_stdout: bool

If stdout writes should be buffered until flush or buffer capacity.

Implementations

impl LoggerConfig

pub fn builder() -> LoggerConfigBuilder

Create an instance of LoggerConfig using the builder syntax

impl LoggerConfig

pub fn new( stdout_level: LevelFilter, fileout_level: LevelFilter, component_level: AHashMap<Ustr, LevelFilter>, module_level: AHashMap<Ustr, LevelFilter>, log_components_only: bool, is_colored: bool, print_config: bool, use_tracing: bool, bypass_logging: bool, file_config: Option<FileWriterConfig>, clear_log_file: bool, ) -> Self

Creates a new LoggerConfig instance.

pub fn validate(&self) -> ConfigResult<()>

Validates the logger configuration.

Errors

Returns a ConfigError if the file writer configuration is invalid (see FileWriterConfig::validate).

pub fn from_spec(spec: &str) -> Result<Self>

Parses a configuration from a spec string.

Format

Semicolon-separated key-value pairs or bare flags:

stdout=Info;fileout=Debug;RiskEngine=Error;my_crate::module=Debug;is_colored

Errors

Returns an error if the spec string contains invalid syntax or log levels.

pub fn from_env() -> Result<Self>

Parses configuration from the NAUTILUS_LOG environment variable.

Errors

Returns an error if the variable is unset or contains invalid syntax.

impl LoggerConfig

pub fn py_from_spec(spec: &str) -> PyResult<Self>

Parses a configuration from a spec string.

Format

Semicolon-separated key-value pairs or bare flags:

stdout=Info;fileout=Debug;RiskEngine=Error;my_crate::module=Debug;is_colored

Errors

Returns an error if the spec string contains invalid syntax or log levels.

Trait Implementations

impl Clone for LoggerConfig

fn clone(&self) -> LoggerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoggerConfig

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

Formats the value using the given formatter.

impl Default for LoggerConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for LoggerConfig

impl<'de> Deserialize<'de> for LoggerConfig

where LoggerConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LoggerConfig

impl<'a, 'py> FromPyObject<'a, 'py> for LoggerConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for LoggerConfig

type Target = LoggerConfig

The Python output type

type Output = Bound<'py, <LoggerConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for LoggerConfig

fn eq(&self, other: &LoggerConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for LoggerConfig

const NAME: &str = "LoggerConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for LoggerConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for the Nautilus logger.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<LoggerConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<LoggerConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForLoggerConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for LoggerConfig

const TEXT_SIGNATURE: &'static str = "(stdout_level=None, fileout_level=None, component_levels=None, is_colored=None, print_config=None, bypass_logging=None, log_components_only=None, file_config=None, clear_log_file=None, fileout_sync_on_flush=None, buffered_stdout=None)"

impl PyStubType for LoggerConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for LoggerConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for LoggerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LoggerConfig