Enum DocumentClass 

pub enum DocumentClass {
    Normal,
    Family,
    Template,
}

What a document is for.

Variants

Normal

A normal part: everything before this slice, imported parts, family members and parts spun out of templates.

Family

A family seed: the model plus the table of its members.

Template

A template: a seed whose marked inputs specialise a new part on insert.

Implementations

impl DocumentClass

pub const ALL: [DocumentClass; 3]

pub fn extension(self) -> &'static str

The file extension, dot included, lowercase.

pub fn field(self) -> Option<&'static str>

The documentClass field’s value; None for a normal part, which writes no field.

pub fn label(self) -> &'static str

The word the UI shows.

pub fn slug(self) -> &'static str

A stable slug for automation keys and blobs.

pub fn of_name(name: &str) -> Option<Self>

The class a file name’s extension names, if it names one.

pub fn of_field(value: Option<&Value>) -> Self

The class a documentClass field value names. Anything else (absent, unknown) is a normal part.

pub fn of_document(document: &Value) -> Self

The class a document’s JSON says it is.

pub fn file_name(self, name: &str) -> String

name with any class extension replaced by this class’s: bolt and bolt.nbrep both become bolt.fbrep for a family. A directory part is kept as it is.

Trait Implementations

impl Clone for DocumentClass

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DocumentClass

impl Debug for DocumentClass

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

Formats the value using the given formatter.

impl Default for DocumentClass

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DocumentClass

impl Hash for DocumentClass

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DocumentClass

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocumentClass