mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-07-30 06:26:38 +00:00
📝 clarify library logger wrapper docs
This commit is contained in:
@@ -3,7 +3,7 @@ name: logger-to-library-logger
|
||||
group: api
|
||||
category: facade
|
||||
update-time: 20260613
|
||||
description: Convert a full sync logger into the narrower library-facing sync facade.
|
||||
description: Convert a full sync logger into the narrower library-facing sync facade without rebuilding the underlying logger state.
|
||||
key-word:
|
||||
- logger
|
||||
- library
|
||||
@@ -34,8 +34,9 @@ pub fn[S] Logger::to_library_logger(self : Logger[S]) -> LibraryLogger[S] {}
|
||||
Detailed rules explaining key parameters and behaviors
|
||||
|
||||
- This conversion does not rebuild the sink or change the logger configuration.
|
||||
- Target, min level, timestamp behavior, and sink wiring are preserved.
|
||||
- Target, min level, timestamp behavior, and sink wiring are preserved because the same underlying logger value is wrapped.
|
||||
- The returned facade keeps library-oriented write APIs such as `info(...)`, `warn(...)`, and `error(...)`.
|
||||
- Broader sync composition helpers remain on the underlying `Logger[S]` and are intentionally hidden until `to_logger()` is used again.
|
||||
|
||||
### How to Use
|
||||
|
||||
@@ -51,6 +52,16 @@ let public_logger = logger.to_library_logger()
|
||||
|
||||
In this example, `public_logger` keeps the same logging behavior but exposes the library facade.
|
||||
|
||||
#### When Need To Narrow Surface Without Resetting Logger Composition
|
||||
|
||||
When an already-shaped logger should be projected to a library boundary without losing its current wrappers:
|
||||
```moonbit
|
||||
let full = Logger::new(console_sink(), target="lib").with_timestamp()
|
||||
let public_logger = full.to_library_logger()
|
||||
```
|
||||
|
||||
In this example, the projection changes the exposed type only; it does not remove the existing timestamp behavior or other logger state.
|
||||
|
||||
### Error Case
|
||||
|
||||
e.g.:
|
||||
@@ -58,8 +69,12 @@ e.g.:
|
||||
|
||||
- The conversion does not remove existing target or field bindings from the original logger.
|
||||
|
||||
- If callers later need composition helpers such as `with_timestamp(...)`, `with_filter(...)`, or `with_patch(...)`, they must unwrap again with `to_logger()`.
|
||||
|
||||
### Notes
|
||||
|
||||
1. Use this when library boundaries should avoid exposing the full sync logger surface.
|
||||
|
||||
2. This is a projection API, not a copy or rebuild step.
|
||||
|
||||
3. Use `build_library_logger(...)` or `parse_and_build_library_logger(...)` when construction and narrowing should happen together from config.
|
||||
|
||||
Reference in New Issue
Block a user