Struct Document 

pub struct Document {
    pub version: SchemaVersion,
    pub creator: Option<String>,
    pub root: Element,
}

A design document: its schema version, the program that wrote it, and the whole XML tree.

Fields

version: SchemaVersion

The root element’s version attribute.

creator: Option<String>

The root element’s creator attribute, for example OpenRocket 24.12. Absent in files some other program wrote.

root: Element

The <openrocket> element, with every attribute and child it was written with.

Implementations

impl Document

pub fn parse(text: &str) -> Result<Imported<Self>, OrkError>

Reads a design document from XML text.

Fails when the text is not well-formed XML, when its root is not <openrocket>, or when the root carries no readable version. Everything else is a warning: a schema version newer than MAX_KNOWN_MINOR, a missing creator, or a comment (which is dropped).

Blank text between child elements (the indentation OpenRocket writes) is not kept, so that writing the document back out is free to lay it out again. Text an element holds beside child elements is kept: OpenRocket writes a simulation <warning> that way.

pub fn to_xml(&self) -> String

Writes the document back out as XML.

The result is written in one fixed style rather than byte-identical to the file it was read from: two-space indentation, attributes in the order they were read, and <tag/> for an empty element. Reading it again gives an equal Document, which is what makes the tree lossless.

version and creator are written onto the root, so changing either changes the file. Everything else comes from root.

This is defined for a document that came from parse. Element’s fields are public, and a tree built by hand can hold a name that is not an XML name, or nest deeper than MAX_DEPTH. Writing either gives XML that will not read back.

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<'de> Deserialize<'de> for Document

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Document

impl PartialEq for Document

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Document

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 Document