Struct Message

pub struct Message {
    pub name: String,
    pub body: Node,
}

One UCI / OMS message: a global element and its body.

Fields

name: String

body: Node

Implementations

impl Message

pub fn violations(&self, schema: &Schema) -> Vec<Violation>

Every way this message departs from schema; empty when none.

See validate for what that does and does not cover.

pub fn from_json(text: &str, schema: &Schema) -> Result<Self, UciError>

Parses OMS JSON. The root is a single-key object whose key is a global element. $type selects a concrete type. An undeclared field is carried as xs:string rather than refused.

Errors

Returns UciError if the text is not a single-key object, the element is unknown, a value cannot be mapped, or nesting exceeds MAX_DEPTH.

pub fn from_xml(text: &str, schema: &Schema) -> Result<Self, UciError>

Parses UCI XML. The root local name is the global element. xsi:type selects a concrete type. Nesting is counted on the text before the tree is built.

Errors

Returns UciError if the document is not well-formed, the element is unknown, an extension chain is cyclic, or nesting exceeds MAX_DEPTH.

pub fn to_json(&self, schema: &Schema) -> Result<String, UciError>

Serializes this message as OMS JSON.

Errors

Returns UciError if an extension chain is cyclic or nesting exceeds MAX_DEPTH.

pub fn to_xml(&self, schema: &Schema) -> Result<String, UciError>

Serializes this message as UCI XML, with the OAM namespace on the root.

Errors

Returns UciError if an extension chain is cyclic or nesting exceeds MAX_DEPTH.

pub fn type_hint(&self) -> &str

The global element name. Same as the OMS JSON root key.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl PartialEq for Message

fn eq(&self, other: &Message) -> 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 StructuralPartialEq for Message