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

🐛 fix native file sink lifecycle behavior

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-14 12:55:29 +08:00
parent 159f534164
commit 31f06f5724
15 changed files with 110 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/configured-logger-file-flush.md
+7 -1
View File
@@ -2,7 +2,7 @@
name: configured-logger-file-flush
group: api
category: runtime
update-time: 20260512
update-time: 20260614
description: Flush the file sink behind a configured runtime logger when one is present.
key-word:
- logger
@@ -35,9 +35,11 @@ Detailed rules explaining key parameters and behaviors
- Plain file sinks forward directly to file flush behavior through the wrapped `RuntimeSink`.
- Queued file sinks first flush queued records, then flush the wrapped inner file sink.
- For queued file sinks, the returned `Bool` comes from the inner file flush rather than the queue flush step.
- For queued file sinks, this step may also be the point where queued records finally hit the inner file sink, so write-failure counters can change here even if earlier log calls only queued records.
- Non-file sinks return `false`.
- This helper is narrower than generic `flush()` because it targets file sink behavior specifically.
- After a file-backed configured logger has already cleared its file handle, later `file_flush()` calls return `false`.
### How to Use
@@ -66,6 +68,8 @@ In this example, callers can distinguish file flush success from a non-file sink
e.g.:
- If the configured sink is not file-backed, the method returns `false`.
- If the file handle was already closed earlier through this logger or another facade sharing the same wrapped runtime sink state, the method returns `false`.
- If callers want generic queue or sink advancement instead of file-specific behavior, `flush()` is the broader API.
### Notes
@@ -73,3 +77,5 @@ e.g.:
1. Prefer this helper when the configured sink is known to be file-backed.
2. Queued file sinks may perform both queue flush and file flush work here, including surfacing delayed write failures from previously queued records.
3. Library or application facades derived from the same configured runtime logger still observe the same underlying file-flush availability state.