Struct json5format::Json5Format

source ·
pub struct Json5Format { /* private fields */ }
Expand description

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

Implementations§

source§

impl Json5Format

source

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.

source

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

Create and return a Json5Format, with the default settings.

source

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)?;
source

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)?;

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.