Struct Example 

pub struct Example {
    pub id: String,
    pub title: String,
    pub rule: String,
    pub status: String,
    pub sources: Vec<String>,
    pub tags: Vec<String>,
    pub appendix: Option<String>,
    pub setup: Setup,
    pub events: Vec<Event>,
    pub changes: Vec<ChangeSpec>,
    pub expect: Vec<Expect>,
}

One bookspec example: a setup, its events and changes, and what it expects of the books.

Fields

id: String

Stable, never reused; the file is named for it.

title: String

What the example shows, in words.

rule: String

The normative sentence the example demonstrates: what MUST (or MUST NOT) hold.

status: String

What the expected values rest on: AUTHORITY, CONVENTION or CHOICE.

sources: Vec<String>

Exact citations, non-empty.

tags: Vec<String>

Applicability tags, non-empty.

appendix: Option<String>

"formats": an interchange format’s example rather than an accounting rule’s (P13’s appendix of formats); absent otherwise.

setup: Setup

The books before the first event.

events: Vec<Event>

The events, in order, counting from 1.

changes: Vec<ChangeSpec>

Changes that post no entry, each made after the event it names.

expect: Vec<Expect>

What is expected of the books, at least one.

Implementations

impl Example

pub fn from_toml(text: &str) -> Result<Self, SchemaError>

Parse an example from its TOML text and check its shape.

pub fn validate(&self) -> Result<(), SchemaError>

Check the example’s shape: its closed lists, its dates and amounts, its references and its events’ and expectations’ forms.

Trait Implementations

impl Clone for Example

fn clone(&self) -> Example

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Example

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Example

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Example

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Example