Struct mentat::Schema

pub struct Schema {
    pub entid_map: BTreeMap<i64, Keyword>,
    pub ident_map: BTreeMap<Keyword, i64>,
    pub attribute_map: BTreeMap<i64, Attribute>,
    pub component_attributes: Vec<i64>,
}

Represents a Mentat schema.

Maintains the mapping between string idents and positive integer entids; and exposes the schema flags associated to a given entid (equivalently, ident).

TODO: consider a single bi-directional map instead of separate ident->entid and entid->ident maps.

Fields

entid_map: BTreeMap<i64, Keyword>

Map entid->ident.

Invariant: is the inverse map of ident_map.

ident_map: BTreeMap<Keyword, i64>

Map ident->entid.

Invariant: is the inverse map of entid_map.

attribute_map: BTreeMap<i64, Attribute>

Map entid->attribute flags.

Invariant: key-set is the same as the key-set of entid_map (equivalently, the value-set of ident_map).

component_attributes: Vec<i64>

Maintain a vec of unique attribute IDs for which the corresponding attribute in attribute_map has .component == true.

Methods

impl Schema

pub fn new(     ident_map: BTreeMap<Keyword, i64>,     entid_map: BTreeMap<i64, Keyword>,     attribute_map: BTreeMap<i64, Attribute> ) -> Schema

pub fn to_edn_value(&self) -> Value

Returns an symbolic representation of the schema suitable for applying across Mentat stores.

pub fn update_component_attributes(&mut self)

Trait Implementations

impl Default for Schema

fn default() -> Schema

Returns the "default value" for a type.

impl PartialOrd<Schema> for Schema

fn partial_cmp(&self, __arg_0: &Schema) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &Schema) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Schema) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &Schema) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Schema) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Clone for Schema

fn clone(&self) -> Schema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Schema

fn cmp(&self, __arg_0: &Schema) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for Schema

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Eq for Schema

impl PartialEq<Schema> for Schema

fn eq(&self, __arg_0: &Schema) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Schema) -> bool

This method tests for !=.

impl HasSchema for Schema

fn entid_for_type(&self, t: ValueType) -> Option<KnownEntid>

fn get_ident<T>(&self, x: T) -> Option<&Keyword> where     T: Into<i64>,

fn get_entid(&self, x: &Keyword) -> Option<KnownEntid>

fn attribute_for_entid<T>(&self, x: T) -> Option<&Attribute> where     T: Into<i64>,

fn attribute_for_ident(     &self,     ident: &Keyword ) -> Option<(&Attribute, KnownEntid)>

fn is_attribute<T>(&self, x: T) -> bool where     T: Into<i64>,

Return true if the provided entid identifies an attribute in this schema.

fn identifies_attribute(&self, x: &Keyword) -> bool

Return true if the provided ident identifies an attribute in this schema.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

fn component_attributes(&self) -> &[i64]

impl Debug for Schema

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.