BitLogger/docs/api/stringify-file-sink-state.md

name, group, category, update-time, description, key-word

name	group	category	update-time	description	key-word
stringify-file-sink-state	api	runtime	20260512	Serialize FileSinkState into compact or pretty JSON text for diagnostics and support output.	file state stringify public

Stringify-file-sink-state

Serialize FileSinkState into JSON text. On the root src facade, this helper forwards to the concrete stringifier owned by src/file_model.

Interface

pub fn stringify_file_sink_state(state : FileSinkState, pretty~ : Bool = false) -> String {}

input

• state : FileSinkState - File sink state snapshot to serialize.
• pretty : Bool - Whether JSON should be pretty-printed.

output

• String - Serialized JSON text for the file sink 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_file_sink_state(...), which is the real owner of this formatting logic.
• This helper builds on top of file_sink_state_to_json(...).
• The output is well-suited for support dumps, incident reports, and log snapshots.
• Typical inputs come from FileSink::state(), RuntimeSink::file_state(), or ConfiguredLogger::file_state().

How to Use

Here are some specific examples provided.

When Need Human-readable File Diagnostics

When file runtime status should be printed for operators:

println(stringify_file_sink_state(runtime.file_state(), pretty=true))

In this example, the full file-state snapshot is rendered in readable JSON.

When Need Compact State Export

When a snapshot should stay small:

let text = stringify_file_sink_state(runtime.file_state())

In this example, compact JSON is returned without extra formatting logic.

Error Case

e.g.:

• If the file is unavailable, the output still serializes normally with available=false.

• If callers need structured composition instead of text, file_sink_state_to_json(...) is the better API.

Notes

1. Use this helper for direct textual file-state snapshots.

2. pretty=true is useful for operator-facing diagnostics and support output.