naloveyuki/BitLogger
1
0
Fork 0
mirror of https://github.com/Nanaloveyuki/BitLogger.git synced 2026-07-31 15:34:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 clarify sync timestamp derivation

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-14 11:55:55 +08:00
parent 5514009abe
commit 8fb9beb008
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/logger-with-timestamp.md
+6
View File
@@ -37,6 +37,8 @@ Detailed rules explaining key parameters and behaviors
- When enabled, `log(...)` captures `@env.now()` and stores it in the record. - When enabled, `log(...)` captures `@env.now()` and stores it in the record.
- When disabled, emitted records use `0UL` as the timestamp value. - When disabled, emitted records use `0UL` as the timestamp value.
- This setting affects later emitted records only. - This setting affects later emitted records only.
- The returned logger is derived from `self`; the original logger value is not mutated.
- Only the stored `timestamp` flag changes. Target, minimum level, and sink behavior stay on the same `Logger[S]` surface.
- Formatter or sink behavior stays unchanged; they just receive records with or without real timestamps. - Formatter or sink behavior stays unchanged; they just receive records with or without real timestamps.
### How to Use ### How to Use
@@ -53,6 +55,8 @@ let logger = Logger::new(console_sink())
In this example, each emitted record captures current time automatically. In this example, each emitted record captures current time automatically.
The returned logger still uses the same ordinary synchronous logging calls; only record timestamp capture changes.
#### When Need Deterministic Or Minimal Records #### When Need Deterministic Or Minimal Records
When timestamps should be disabled for tests or reduced output: When timestamps should be disabled for tests or reduced output:
@@ -76,3 +80,5 @@ e.g.:
2. It works well together with text formatters that optionally show timestamps. 2. It works well together with text formatters that optionally show timestamps.
3. Use a derived logger value when one path should capture timestamps and another should keep the original deterministic record shape.