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

📝 clarify async runtime state alias provenance

Browse Source
This commit is contained in:
Nanaloveyuki
2026-06-14 10:20:05 +08:00
parent 5957e37720
commit 5edd853fc5
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/async-runtime-state-type.md
+3
View File
@@ -35,6 +35,7 @@ Detailed rules explaining key parameters and behaviors
- `async_runtime_state()` currently builds that snapshot from `async_runtime_mode()` and `async_runtime_supports_background_worker()`.
- `async_runtime_state_to_json(...)` and `stringify_async_runtime_state(...)` serialize the same snapshot shape for diagnostics.
- `AsyncRuntimeState::new(...)` can also construct this type manually, but manual construction is synthetic data and does not probe the current backend by itself.
- The type itself does not distinguish live backend snapshots from hand-built ones; callers must track whether a given `AsyncRuntimeState` value came from `async_runtime_state()` or from manual construction.
### How to Use
@@ -70,6 +71,8 @@ e.g.:
- Because this is just a data shape, manual construction can represent combinations that do not come from the current backend probe.
- Receiving an `AsyncRuntimeState` value alone does not prove it came from the current backend rather than from a synthetic constructor path.
### Notes
1. Use `async_runtime_state()` when you need a value of this type from the current backend.