BitLogger/docs/api/file-sink-state-to-json.md

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

name	group	category	update-time	description	key-word
file-sink-state-to-json	api	runtime	20260512	Convert FileSinkState into a JSON value for file sink diagnostics and state transport.	file state json public

File-sink-state-to-json

Convert FileSinkState into a JsonValue. This helper exports file path, availability, policy flags, rotation config, and failure counters in a structured form.

Interface

pub fn file_sink_state_to_json(state : FileSinkState) -> @json_parser.JsonValue {}

input

• state : FileSinkState - File sink state snapshot to export.

output

• JsonValue - Structured JSON representation of the file sink state.

Explanation

Detailed rules explaining key parameters and behaviors

• The output includes path, available, append, auto_flush, failure counters, and rotation.
• rotation is exported as null when rotation is disabled.
• This helper exports state snapshots, not mutable runtime control handles.
• It is useful when file sink state should be embedded into larger diagnostics payloads.

How to Use

Here are some specific examples provided.

When Need Structured File Diagnostics

When file sink status should be composed into a larger JSON object:

let value = file_sink_state_to_json(sink.state())

In this example, callers receive a structured file-state snapshot instead of plain text.

When Need Runtime State Snapshots For Tooling

When support tooling should ingest file sink state programmatically:

let snapshot = file_sink_state_to_json(state)

In this example, the helper exposes all major file-state fields in machine-readable form.

Error Case

e.g.:

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

• If callers need direct text output, stringify_file_sink_state(...) is the better API.

Notes

1. Use this helper when diagnostics consumers expect JsonValue.

2. It pairs naturally with FileSink::state() and ConfiguredLogger::file_state().