3.3 KiB
name, group, category, update-time, description, key-word
| name | group | category | update-time | description | key-word | ||||
|---|---|---|---|---|---|---|---|---|---|
| application-logger | api | facade | 20260613 | Application-facing alias for the configured sync runtime logger surface, preserving the full ConfiguredLogger helper set. |
|
Application-logger
ApplicationLogger is the application-facing sync logger alias. It currently maps directly to ConfiguredLogger and keeps the same runtime helper surface for sync logging, queue inspection, and file controls.
Interface
pub type ApplicationLogger = ConfiguredLogger
output
ApplicationLogger- Application-facing name for the configured sync runtime logger shape.
Explanation
Detailed rules explaining key parameters and behaviors
- This alias does not introduce a new runtime type or wrapper layer.
- It preserves the same logging, queue, and file helper APIs exposed by
ConfiguredLogger. - Because
ConfiguredLoggeris itselfLogger[RuntimeSink], the alias also keeps ordinary logger composition and write behavior such aswith_target(...),child(...), andlog(..., target=...). - Because this is only an alias, the application-facing type does not hide any configured-runtime helpers or broader logger surface.
- The alias exists to give application boot code a clearer public entry name.
- Builders such as
build_application_logger(...)andparse_and_build_application_logger(...)return this alias.
How to Use
Here are some specific examples provided.
When Need An App-level Name For The Configured Runtime Logger
When application code wants a stable public type name for the configured sync logger:
let logger : ApplicationLogger = build_application_logger(LoggerConfig::new(target="app"))
In this example, the application alias keeps the same underlying runtime logger behavior while presenting an app-facing type name.
When Pass The Configured Logger Through App-level APIs
When top-level boot code or services should expose an application-oriented logger type:
fn start(logger : ApplicationLogger) -> Unit {
logger.info("started")
}
In this example, callers see the app-facing alias instead of the lower-level ConfiguredLogger name.
And the same queue/file/runtime helpers remain directly callable because no narrowing wrapper is added.
And the inherited logger target rules stay the same: log(..., target=...) can override the target per call, while with_target(...) and child(...) derive new logger values with changed default targets.
Error Case
e.g.:
-
Because this is only an alias, any backend limitations of
ConfiguredLoggerstill apply unchanged. -
If code needs a narrower public surface than the full configured runtime logger,
LibraryLoggeris the better facade.
Notes
-
This alias is about naming and public intent, not a different runtime implementation.
-
Inherited
Loggerbehavior stays unchanged on this alias, including target overrides onlog(...)and derived target composition throughwith_target(...)andchild(...). -
Use
build_application_logger(...)orparse_and_build_application_logger(...)for the usual construction paths. -
Use
LibraryLoggerinstead when a library boundary should intentionally hide configured-runtime helper methods behind a narrower facade.