Trait Ent

Source

pub trait Ent:
    AsAny
    + DynClone
    + Send
    + Sync {
Show 28 methods    // Required methods
    fn id(&self) -> Id;
    fn set_id(&mut self, id: Id);
    fn type(&self) -> &str;
    fn created(&self) -> u64;
    fn last_updated(&self) -> u64;
    fn mark_updated(&mut self) -> Result<(), EntMutationError>;
    fn field_definitions(&self) -> Vec<FieldDefinition>;
    fn field(&self, name: &str) -> Option<Value>;
    fn update_field(
        &mut self,
        name: &str,
        value: Value,
    ) -> Result<Value, EntMutationError>;
    fn edge_definitions(&self) -> Vec<EdgeDefinition>;
    fn edge(&self, name: &str) -> Option<EdgeValue>;
    fn update_edge(
        &mut self,
        name: &str,
        value: EdgeValue,
    ) -> Result<EdgeValue, EntMutationError>;
    fn connect(&mut self, database: WeakDatabaseRc);
    fn disconnect(&mut self);
    fn is_connected(&self) -> bool;
    fn load_edge(&self, name: &str) -> DatabaseResult<Vec<Box<dyn Ent>>>;
    fn clear_cache(&mut self);
    fn refresh(&mut self) -> DatabaseResult<()>;
    fn commit(&mut self) -> DatabaseResult<()>;
    fn remove(&self) -> DatabaseResult<bool>;

    // Provided methods
    fn field_definition(&self, name: &str) -> Option<FieldDefinition> { ... }
    fn field_names(&self) -> Vec<String> { ... }
    fn field_type(&self, name: &str) -> Option<ValueType> { ... }
    fn fields(&self) -> Vec<Field> { ... }
    fn edge_definition(&self, name: &str) -> Option<EdgeDefinition> { ... }
    fn edge_names(&self) -> Vec<String> { ... }
    fn edge_type(&self, name: &str) -> Option<EdgeValueType> { ... }
    fn edges(&self) -> Vec<Edge> { ... }
}

Expand description

Represents the interface for a generic entity whose fields and edges can be accessed by str name regardless of compile-time characteristics

Based on https://www.usenix.org/system/files/conference/atc13/atc13-bronson.pdf

Required Methods§

Source

fn id(&self) -> Id

Represents the unique id associated with each entity instance

Source

fn set_id(&mut self, id: Id)

Updates the id of this ent, useful for databases that want to adjust the id or when you want to produce a clone of the ent in a database by resetting its id to ephemeral prior to storing it

Source

fn type(&self) -> &str

Represents a unique type associated with the entity, used for lookups, indexing by type, and conversions

Source

fn created(&self) -> u64

Represents the time when the instance of the ent was created as the milliseconds since epoch (1970-01-01 00:00:00 UTC)

Source

fn last_updated(&self) -> u64

Represents the time when the instance of the ent was last updated as the milliseconds since epoch (1970-01-01 00:00:00 UTC)

Source

fn mark_updated(&mut self) -> Result<(), EntMutationError>

Updates the time when the instance of the ent was last updated to the current time in milliseconds since epoch (1970-01-01 00:00:00 UTC)

Source

fn field_definitions(&self) -> Vec<FieldDefinition>

Returns a list of definitions for fields contained by the ent

Source

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

Returns a copy of the value of the field with the specified name

Source

fn update_field( &mut self, name: &str, value: Value, ) -> Result<Value, EntMutationError>

Updates the local value of a field with the specified name, returning the old field value if updated. This will also update the last updated time for the ent.

Source

fn edge_definitions(&self) -> Vec<EdgeDefinition>

Returns a list of definitions for edges contained by the ent

Source

fn edge(&self, name: &str) -> Option<EdgeValue>

Returns a copy of the value of the edge with the specified name

Source

fn update_edge( &mut self, name: &str, value: EdgeValue, ) -> Result<EdgeValue, EntMutationError>

Updates the local value of an edge with the specified name, returning the old edge value if updated. This will also update the last updated time for the ent.

Source