Struct WdfDocument 

pub struct WdfDocument {
    pub schema: String,
    pub version: u32,
    pub root: WdfRoot,
}

The canonical WDF document.

This is the model every adapter converts into and out of. It serializes to (and deserializes from) WDF JSON, so serde_json::to_value(&doc) produces canonical WDF JSON ready to store or send over the wire.

Documents received from the outside world should go through crate::validate_and_canonicalize rather than plain deserialization: deserialization alone accepts structurally valid but semantically invalid documents (unknown marks, empty lists, heading level 0, …) and skips canonicalization.

Fields

schema: String

Always WDF_SCHEMA after canonicalization.

version: u32

Always WDF_VERSION after canonicalization.

root: WdfRoot

The document root; node_type is "doc".

Implementations

impl WdfDocument

pub fn empty() -> Self

An empty document: one empty paragraph, valid out of the box.

Trait Implementations

impl Clone for WdfDocument

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 WdfDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WdfDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WdfDocument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WdfDocument

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 WdfDocument