Skip to main content

SynxlDocument

Struct SynxlDocument 

Source
pub struct SynxlDocument {
    pub version: u32,
    pub records: Vec<Value>,
    pub field_lists: Vec<FieldList>,
    pub record_field_lists: Vec<usize>,
    pub record_lines: Vec<usize>,
    pub diagnostics: Vec<Diagnostic>,
}
Expand description

A fully materialised SYNXL document.

Fields§

§version: u32

Format version from the prologue (§4.1).

§records: Vec<Value>

Records in document order; each is a Value::Object.

§field_lists: Vec<FieldList>

Every field list in declaration order (§4.2).

§record_field_lists: Vec<usize>

records[i] was parsed under field_lists[record_field_lists[i]].

§record_lines: Vec<usize>

1-based source line of each record’s record line.

§diagnostics: Vec<Diagnostic>

All diagnostics, in record order (§11.2).

Implementations§

Source§

impl SynxlDocument

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn field_list_for(&self, index: usize) -> Option<&FieldList>

The field list that was in effect for record index.

Source

pub fn to_json(&self) -> String

Canonical JSON array projection (§12.1).

Source

pub fn to_ndjson(&self) -> String

Canonical NDJSON projection (§12.2).

Source

pub fn to_synxl(&self) -> Result<String, SynxlError>

Canonical SYNXL serialization (§14).

Infallible in practice for a parsed document (§14.1); see write_document for the one condition that rejects.

Trait Implementations§

Source§

impl Clone for SynxlDocument

Source§

fn clone(&self) -> SynxlDocument

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SynxlDocument

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SynxlDocument

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SynxlDocument

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.