Struct StructureDocument 

pub struct StructureDocument {
    pub schema_version: u32,
    pub structure: Structure,
}

Versioned JSON envelope for a structure.

Fields

schema_version: u32

Schema version, independent of the crate version.

structure: Structure

The structure payload.

Implementations

impl StructureDocument

pub fn new(structure: Structure) -> Self

Wraps a structure in the current schema version.

pub fn to_json(&self) -> Result<String, Error>

Serializes the document to JSON.

Errors

Returns Error::InvalidInput if serialization fails.

pub fn from_json(text: &str) -> Result<Self, Error>

Parses a document and checks its schema version.

Errors

Returns Error::InvalidInput for invalid JSON, unknown fields or an unsupported schema version.

Trait Implementations

impl Clone for StructureDocument

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 StructureDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructureDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StructureDocument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StructureDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StructureDocument