Struct JsonPrettyOptionsBuilder 

pub struct JsonPrettyOptionsBuilder { /* private fields */ }

Builder for whitespace formatting choices.

The displayed indentation cap does not constrain JSON nesting. All current settings are accepted by Self::build.

Examples

use qubit_json::format::{format_json_tokens, JsonPrettyOptions};

let options = JsonPrettyOptions::builder()
    .indent_width(2)
    .trailing_newline(true)
    .build()?;
let output = format_json_tokens(b"[1]", &options, None)?;
assert_eq!(output, b"[\n  1\n]\n");

Implementations

impl JsonPrettyOptionsBuilder

pub fn indent_width(self, spaces: usize) -> Self

Sets spaces per displayed indentation level; zero is valid.

Parameters

• spaces - Number of spaces used for each displayed level.

Returns

The builder with the requested indentation width.

pub fn max_indent_levels(self, maximum: Option<usize>) -> Self

Caps displayed indentation while preserving real nesting state.

None leaves displayed depth uncapped; Some(0) emits no indentation. The cap does not limit the input’s actual nesting depth.

Parameters

• maximum - Maximum displayed indentation level, if any.

Returns

The builder with the displayed-depth cap configured.

pub fn trailing_newline(self, enabled: bool) -> Self

Controls whether one final newline is emitted.

Parameters

• enabled - Whether to append one newline after the formatted value.

Returns

The builder with the final-newline choice configured.

pub fn build(self) -> Result<JsonPrettyOptions, JsonPrettyError>

Builds the options. All combinations are valid.

The Result return type is retained for API compatibility; this method currently returns Ok for every configuration.

Returns

The configured options. The result is currently always Ok.

Trait Implementations

impl Clone for JsonPrettyOptionsBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for JsonPrettyOptionsBuilder

impl Debug for JsonPrettyOptionsBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JsonPrettyOptionsBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Eq for JsonPrettyOptionsBuilder

impl PartialEq for JsonPrettyOptionsBuilder

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for JsonPrettyOptionsBuilder