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

📝 clarify api target verification status

Browse Source
This commit is contained in:
Nanaloveyuki
2026-05-21 14:14:15 +08:00
parent 3eee5893f5
commit 6c19708d7b
8 changed files with 97 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/file-sink.md
+6 -1
View File
@@ -43,7 +43,9 @@ pub fn file_sink(
Detailed rules explaining key parameters and behaviors
- This sink is only available on `native/llvm`; use `native_files_supported()` for capability detection.
- This sink is designed for host-file capable backends, with current local verification centered on `native`.
- `llvm` should be treated as experimental in the current release context and was not successfully re-verified in this environment.
- The `src` library is still designed for multi-target compilation, but file sink availability remains backend-sensitive inside that broader portable surface.
- `append` is persistent policy state and also affects later reopen behavior.
- `auto_flush` trades durability for more flush work per record.
- Rotation is currently size-based and rename-retention-oriented, not time-based.
@@ -91,3 +93,6 @@ e.g.:
2. Prefer `state()`, `policy()`, and failure counters when integrating diagnostics.
3. Non-native targets can still compile code referencing this API, but callers should treat actual file availability and successful writes as target-sensitive runtime behavior.
4. See [target-verification.md](./target-verification.md) for the current verification boundary between design intent and locally re-checked targets.