BitLogger/docs/api/logger-config-new.md

name, group, category, update-time, description, key-word

name	group	category	update-time	description	key-word
logger-config-new	api	config	20260613	Construct the main LoggerConfig value for config-driven runtime logger assembly.	logger config constructor public

Logger-config-new

Construct a LoggerConfig value for config-driven runtime logger assembly. This constructor stores level, target, timestamp behavior, sink shape, and optional queue wrapping as one typed config object.

Interface

pub fn LoggerConfig::new(
  min_level~ : Level = Level::Info,
  target~ : String = "",
  timestamp~ : Bool = false,
  sink~ : SinkConfig = default_sink_config(),
  queue~ : QueueConfig? = None,
) -> LoggerConfig {

input

• min_level : Level - Global level gate.
• target : String - Default target namespace.
• timestamp : Bool - Whether the built logger should emit timestamps.
• sink : SinkConfig - Configured sink shape.
• queue : QueueConfig? - Optional synchronous queue wrapper.

output

• LoggerConfig - Main logger configuration object.

Explanation

Detailed rules explaining key parameters and behaviors

• The constructor stores the supplied logging policy and sink config directly.
• min_level defaults to Level::Info, target defaults to "", and timestamp defaults to false.
• sink defaults to default_sink_config().
• queue=None means no configured synchronous queue layer.

How to Use

Here are some specific examples provided.

When Build Config In Code Instead Of JSON

When application bootstrapping prefers typed config values:

let config = LoggerConfig::new(
  min_level=Level::Warn,
  target="svc",
  timestamp=true,
  sink=SinkConfig::new(kind=SinkKind::TextConsole),
)

In this example, the logger configuration is explicit and strongly typed.

When Prepare Config For A Later Builder

When config is assembled in one place and built later:

let config = LoggerConfig::new(queue=Some(QueueConfig::new(16)))
let logger = build_logger(config)

In this example, the config object becomes the handoff boundary between assembly and runtime construction.

Error Case

e.g.:

• If sink describes a capability-limited backend shape such as native file output on a non-native target, later runtime behavior still follows backend support rules.

• If target is empty, the configuration is still valid.

Notes

1. This is the core typed constructor for sync logger assembly.

2. Prefer this API when config is generated in code rather than parsed from text.