substrate-data 0.3.1

One data model, text syntax, binary form, packed frames and schema system — for any program's files, saves and wire messages.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! The words the formats share, defined once: the typed value grammar's
//! mark and the keys a format's own structure uses. Problem codes are
//! [`crate::diagnostic::Problem`]; the words a shape is described by are
//! [`crate::schema::ShapeNode`]'s variants.

use std::fmt;

/// What starts a typed value: `@file:images/logo.png`.
pub const TYPED: char = '@';

/// Keys a format's own structure uses.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Word {
    /// The key naming a tagged enum's variant: `{ type: "estimate", … }`.
    Type,
    /// Where a tagged enum's variant keeps what it wraps when that isn't a struct.
    Value,
}

impl Word {
    /// As written.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Word::Type => "type",
            Word::Value => "value",
        }
    }
}

impl fmt::Display for Word {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}