mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-07-24 08:52:35 +00:00
Nanaloveyuki
81 lines
2.5 KiB
Markdown
81 lines
2.5 KiB
Markdown
---
|
|
name: stringify-runtime-file-state
|
|
group: api
|
|
category: runtime
|
|
update-time: 20260512
|
|
description: Serialize RuntimeFileState into compact or pretty JSON text for queued-file diagnostics and support output.
|
|
key-word:
|
|
- runtime
|
|
- file
|
|
- state
|
|
- public
|
|
---
|
|
|
|
## Stringify-runtime-file-state
|
|
|
|
Serialize `RuntimeFileState` into JSON text. On the root `src` facade, this helper forwards to the concrete stringifier owned by `src/file_model`.
|
|
|
|
### Interface
|
|
|
|
```moonbit
|
|
pub fn stringify_runtime_file_state(state : RuntimeFileState, pretty~ : Bool = false) -> String {}
|
|
```
|
|
|
|
#### input
|
|
|
|
- `state : RuntimeFileState` - Combined file and queue runtime snapshot to serialize.
|
|
- `pretty : Bool` - Whether JSON should be pretty-printed.
|
|
|
|
#### output
|
|
|
|
- `String` - Serialized JSON text for the runtime file state.
|
|
|
|
### Explanation
|
|
|
|
Detailed rules explaining key parameters and behaviors
|
|
|
|
- `pretty=false` returns compact JSON.
|
|
- `pretty=true` returns indented JSON for human diagnostics.
|
|
- The root surface forwards to `@file_model.stringify_runtime_file_state(...)`, which is the real owner of this formatting logic.
|
|
- This helper builds on top of `runtime_file_state_to_json(...)`.
|
|
- The output is useful when queued file runtime state should be printed directly during support or incident handling.
|
|
- Typical inputs come from `RuntimeSink::file_runtime_state()` or `ConfiguredLogger::file_runtime_state()`.
|
|
|
|
### How to Use
|
|
|
|
Here are some specific examples provided.
|
|
|
|
#### When Need Human-readable Queued-file Diagnostics
|
|
|
|
When a queued file runtime snapshot should be printed directly:
|
|
```moonbit
|
|
match runtime.file_runtime_state() {
|
|
Some(snapshot) => println(stringify_runtime_file_state(snapshot, pretty=true))
|
|
None => ()
|
|
}
|
|
```
|
|
|
|
In this example, both file state and queue metrics are shown in one readable JSON payload after the optional runtime snapshot is checked.
|
|
|
|
#### When Need Compact Runtime Snapshot Export
|
|
|
|
When a combined file-and-queue snapshot should stay small:
|
|
```moonbit
|
|
let text = stringify_runtime_file_state(snapshot)
|
|
```
|
|
|
|
In this example, compact JSON is returned without extra formatting logic.
|
|
|
|
### Error Case
|
|
|
|
e.g.:
|
|
- If callers need a `Json` rather than text, `runtime_file_state_to_json(...)` is the better API.
|
|
|
|
- If queue wrapping is not relevant, `stringify_file_sink_state(...)` may be the simpler API.
|
|
|
|
### Notes
|
|
|
|
1. Use this helper when queued-file diagnostics should be emitted as one JSON string.
|
|
|
|
2. `pretty=true` is useful for support output and manual inspection.
|