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

📝 refine configured runtime file state docs

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-13 23:45:46 +08:00
parent ce3eb06c1c
commit 8427cc6cf3
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/configured-logger-file-runtime-state.md
+1 -1
View File
@@ -33,7 +33,7 @@ pub fn ConfiguredLogger::file_runtime_state(self : ConfiguredLogger) -> RuntimeF
Detailed rules explaining key parameters and behaviors
- File-backed sinks return `Some(RuntimeFileState)`.
- File-backed sinks return `Some(RuntimeFileState)` through the wrapped `RuntimeSink`.
- Queued file sinks include both file status and queue metrics in the returned state.
- Non-file sinks return `None`.
- This helper is richer than `file_state()` because it can also surface queued backlog and dropped counts.
docs/api/configured-logger-file-state.md
+2 -2
View File
@@ -34,8 +34,8 @@ pub fn ConfiguredLogger::file_state(self : ConfiguredLogger) -> FileSinkState {}
Detailed rules explaining key parameters and behaviors
- File-backed sinks return a live snapshot of file state.
- Queued file sinks forward the snapshot from the wrapped file sink.
- Non-file sinks return a fallback empty-state snapshot.
- Queued file sinks forward the snapshot from the wrapped inner file sink.
- Non-file sinks return the same fallback empty-style state produced by `RuntimeSink::file_state()`, with an empty path, disabled policy flags, no rotation, and zeroed counters.
- This helper is broader than individual file counters or policy accessors because it aggregates core file status into one read.
### How to Use