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

📝 refine async policy docs

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-14 00:33:59 +08:00
parent 7207c07cbf
commit 2845076b27
3 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/async-logger-flush-policy.md
+4 -4
View File
@@ -2,8 +2,8 @@
name: async-logger-flush-policy
group: api
category: async
update-time: 20260512
description: Read the async logger flush policy currently governing batch and shutdown flushing behavior.
update-time: 20260614
description: Read the async logger flush policy currently governing batch-end and shutdown-end flushing behavior.
key-word:
- async
- logger
@@ -34,8 +34,8 @@ pub fn[S] AsyncLogger::flush_policy(self : AsyncLogger[S]) -> AsyncFlushPolicy {
Detailed rules explaining key parameters and behaviors
- The returned value reflects the policy captured when the async logger was created.
- `Batch` causes explicit flush calls after worker batch processing.
- `Shutdown` causes explicit flush calls at worker shutdown.
- `Batch` causes explicit flush calls after each completed drained batch, not after every individual record write.
- `Shutdown` causes one explicit flush call after the worker loop exits.
- `Never` leaves flushing entirely to sink behavior or external control.
### How to Use