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

📝 refresh runtime file constructors docs

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-13 23:39:24 +08:00
parent 56ba583680
commit 342d08377f
3 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/file-sink-state-new.md
+2 -2
View File
@@ -54,7 +54,7 @@ Detailed rules explaining key parameters and behaviors
- Omitting optional arguments uses a conservative baseline snapshot: unavailable, append enabled, auto-flush enabled, no rotation, and zeroed counters.
- This constructor simply packages the supplied fields into one public snapshot value.
- It does not inspect a live `FileSink` by itself.
- `FileSink::state()` and `ConfiguredLogger::file_state()` are the higher-level APIs that read these values from concrete runtime objects.
- `FileSink::state()`, `RuntimeSink::file_state()`, and `ConfiguredLogger::file_state()` are the higher-level APIs that read these values from concrete runtime objects.
### How to Use
@@ -99,7 +99,7 @@ In this example, callers still use the direct constructor while making each diag
e.g.:
- This constructor itself does not have a normal failure mode; it only packages the provided values.
- If callers want a snapshot directly from a live file sink or configured logger, `state()` or `file_state()` is the simpler API.
- If callers want a snapshot directly from a live file sink, runtime sink, or configured logger, `state()` or `file_state()` is the simpler API.
### Notes