Struct json5format::Json5Format

pub struct Json5Format { /* fields omitted */ }

A JSON5 formatter that parses a valid JSON5 input buffer and produces a new, formatted document.

Implementations

impl Json5Format

pub fn with_options(options: FormatOptions) -> Result<Self, Error>

Create and return a Json5Format, with the given options to be applied to the Json5Format::to_utf8() operation.

pub fn new() -> Result<Self, Error>

Create and return a Json5Format, with the default settings.

pub fn to_utf8(
    &self,
    parsed_document: &ParsedDocument
) -> Result<Vec<u8>, Error>

Formats the parsed document into a new Vector of UTF8 bytes.

Arguments

• parsed_document - The parsed state of the incoming document.

Example

let format = Json5Format::new()?;
let parsed_document = ParsedDocument::from_str(&buffer, Some(filename))?;
let bytes = format.to_utf8(&parsed_document)?;

pub fn to_string(
    &self,
    parsed_document: &ParsedDocument
) -> Result<String, Error>

Formats the parsed document into a new String.

Arguments

• parsed_document - The parsed state of the incoming document.

Example

let format = Json5Format::new()?;
let parsed_document = ParsedDocument::from_str(&buffer, Some(filename))?;
let formatted = format.to_string(&parsed_document)?;