Struct Document 

pub struct Document { /* private fields */ }

A parsed document that owns its unchanged source text.

Implementations

impl Document

pub fn parse(source: impl Into<String>, limits: &Limits) -> Result<Self, Error>

Parses a complete document.

Errors

Returns the first syntax or limit violation with its byte offset.

pub fn source(&self) -> &str

pub const fn root(&self) -> &Value

pub fn text(&self, span: Span) -> &str

The exact source text of a span.

Panics

Panics if the span is not a span of this document.

pub fn canonical(&self, value: &Value) -> String

Canonical minified JSON for a value of this document: no comments or whitespace, members in source order, numbers spelled exactly as in the source, and strings escaped minimally (", \\ and control characters only). Equal values from equal source text always give equal output.

Panics

Panics if the value is not part of this document.

pub fn replace( &self, span: Span, text: &str, limits: &Limits, ) -> Result<Self, Error>

Replaces one span with new text and parses the result. Every byte outside the span is preserved.

Errors

Returns ErrorCode::InvalidEdit for a span outside the document or not on character boundaries, or any error of the edited document.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

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 PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document