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

📝 consolidate logger API and async lifecycle guidance

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-14 14:00:00 +08:00
parent 4f2ad097af
commit 265cd69ea9
154 changed files with 2419 additions and 396 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/runtime-sink-file-flush.md
+8 -2
View File
@@ -2,7 +2,7 @@
name: runtime-sink-file-flush
group: api
category: runtime
update-time: 20260613
update-time: 20260614
description: Flush the file sink behind a RuntimeSink when one is present.
key-word:
- runtime
@@ -36,7 +36,9 @@ Detailed rules explaining key parameters and behaviors
- Plain `File` runtime variants forward directly to `FileSink::flush()`.
- `QueuedFile` runtime variants first attempt `sink.flush()` on the queue wrapper, then call `sink.sink.flush()` on the wrapped file sink.
- For `QueuedFile`, the queue flush result is ignored and the returned `Bool` comes from the inner file flush.
- For `QueuedFile`, this step may also be the point where queued records finally reach the inner file sink, so write-failure counters can change here even if earlier `log(...)` calls only enqueued records.
- Non-file runtime variants return `false`.
- After a file-backed runtime sink has already cleared its handle, later `file_flush()` calls return `false`.
### How to Use
@@ -65,10 +67,14 @@ In this example, callers can distinguish file flush success from a non-file sink
e.g.:
- If the runtime sink is not file-backed, the method returns `false`.
- If the file handle was already closed earlier through this runtime sink or another facade sharing the same underlying file-backed state, the method returns `false`.
- If callers want generic queue or sink advancement instead of file-specific behavior, `flush()` is the broader API.
### Notes
1. Prefer this helper when direct runtime code specifically cares about file flush behavior.
2. Queued file sinks may perform both queue flush work and file flush work here.
2. Queued file sinks may perform both queue flush work and file flush work here, including surfacing delayed write failures from previously queued records.
3. Library or application facades that share the same wrapped file-backed runtime sink still observe the same flush availability state.