Struct UsageDoc 

pub struct UsageDoc {
    pub schema_version: u32,
    pub schema_supported: bool,
    pub plots: Vec<PlotEntry>,
    pub warnings: Vec<String>,
}

A parsed usage document. Parsing never fails; problems are recorded as warnings and the rest of the document is still parsed.

Fields

schema_version: u32

Schema version declared in the document (0 when absent).

schema_supported: bool

False when the document declares a newer schema than we support.

plots: Vec<PlotEntry>

Successfully parsed plot blocks, in document order.

warnings: Vec<String>

Non-fatal problems encountered while parsing.

Implementations

impl UsageDoc

pub fn schema_supported(&self) -> bool

True when the document’s schema version is understood by this binary.

pub fn declared_schema_version(&self) -> Option<u32>

The declared schema version, or None when the document has none.

pub fn get(&self, id: &str) -> Option<&PlotEntry>

Look up a plot block by its stable id.

Trait Implementations

impl Clone for UsageDoc

fn clone(&self) -> UsageDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageDoc

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

Formats the value using the given formatter.

impl Default for UsageDoc

fn default() -> UsageDoc

Returns the “default value” for a type.