Struct ClassSchema 

pub struct ClassSchema {
    pub class_name: String,
    pub fields: IndexMap<String, FieldType>,
}

The shape of one class: what a transform needs to lower or raise a document.

Order-preserving, because _SCHEMA documents are compared in golden files and because the order fields were added is the order upstream writes them.

Fields

class_name: String

fields: IndexMap<String, FieldType>

Implementations

impl ClassSchema

pub fn new(class_name: impl Into<String>) -> Self

pub fn with_field(self, name: impl Into<String>, ty: FieldType) -> Self

pub fn field(&self, name: &str) -> Option<&FieldType>

pub fn is_pointer_field(&self, name: &str) -> bool

Is this field stored under a _p_ prefix?

Note the deliberate narrowness: only a declared Pointer field is prefixed. A pointer value written to a field the schema does not know about is not prefixed by transformKey, because that function consults the schema and nothing else.

Trait Implementations

impl Clone for ClassSchema

fn clone(&self) -> ClassSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClassSchema

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

Formats the value using the given formatter.

impl Default for ClassSchema

fn default() -> ClassSchema

Returns the “default value” for a type.