Struct Document 

pub(crate) struct Document {
    dialect: Dialect,
    pub(super) value: Value,
    trailing: Trivia,
    indent: Indent,
}

The root of a parsed or built document.

Fields

dialect: Dialect

value: Value

trailing: Trivia

indent: Indent

One level of indentation, for members inserted into the document.

Implementations

impl Document

pub(super) fn parsed(dialect: Dialect, value: Value, trailing: Trivia) -> Self

A parsed document. Its indent is the unit of its first multi-line member, or two spaces.

pub(super) fn end_with_newline(&mut self)

End the document with exactly one line break.

pub(super) fn parse(source: &str, dialect: Dialect) -> Result<Self, JsonError>

Parse source as JSON5, whatever the dialect. The dialect only governs how the document is written back.

Errors

Returns the first syntax error, with its byte offset.

pub(super) fn build(tree: &Annotated, dialect: Dialect) -> Self

The canonical rendering of tree.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Display for Document

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

Formats the value using the given formatter.

impl Editable for Document

fn root_mut(&mut self) -> &mut Value

The root value, ready for members to be inserted.

type Node = Value

fn header_text(&self) -> &str

The text of the header comment of this document.

fn leading(&self) -> (&str, &str)

The text before the first entry as the document root holds it and as the first entry holds it. A format that keeps all of it in one place returns an empty root text.

fn set_leading(&mut self, applied: Applied<'_>)

Put the leading text of an applied header in place.

fn root(&self) -> &Value

The root node.

fn apply_header(&mut self, desired: &Self, existing: Existing)

Replace the leading comment block of this document with the header of desired.