Trait ObjectSpace 

pub trait ObjectSpace {
    // Required methods
    fn entities(&self) -> Vec<EntityInfo>;
    fn query(
        &self,
        entity: &str,
        query: &Query,
    ) -> Result<Vec<Object>, SpaceError>;
    fn find(
        &self,
        entity: &str,
        key: &Value,
    ) -> Result<Option<Object>, SpaceError>;
    fn new_object(&mut self, entity: &str) -> Result<Object, SpaceError>;
    fn save(&mut self, object: Object) -> Result<(), SpaceError>;
    fn insert(&mut self, object: Object) -> Result<(), SpaceError>;
    fn delete(&mut self, entity: &str, key: &Value) -> Result<(), SpaceError>;
    fn changes(&self) -> Vec<Change>;
    fn commit(&mut self) -> Result<(), SpaceError>;
    fn rollback(&mut self);
    fn on_event(&mut self, watcher: SpaceWatcher);

    // Provided methods
    fn is_modified(&self) -> bool { ... }
    fn refresh(&mut self) { ... }
}

A unit of work over records: what it reads includes its own changes, and nothing reaches storage until commit. A view has one of these, so canceling a form throws away only that form’s changes.

Required Methods

fn entities(&self) -> Vec<EntityInfo>

The entities it knows.

fn query(&self, entity: &str, query: &Query) -> Result<Vec<Object>, SpaceError>

Reads records.

fn find(&self, entity: &str, key: &Value) -> Result<Option<Object>, SpaceError>

Reads one record by its key.

fn new_object(&mut self, entity: &str) -> Result<Object, SpaceError>

A record with what a new one starts with, kept only once saved.

fn save(&mut self, object: Object) -> Result<(), SpaceError>

Marks a record as new or changed, by its key.

fn insert(&mut self, object: Object) -> Result<(), SpaceError>

Marks a record as new, refusing a key already in use, as a form creating a record has to: it must not take over the record with that key.

fn delete(&mut self, entity: &str, key: &Value) -> Result<(), SpaceError>

Marks a record to go away.

fn changes(&self) -> Vec<Change>

What waits for a commit.

fn commit(&mut self) -> Result<(), SpaceError>

Keeps every change, or none of them.

fn rollback(&mut self)

Throws away every change.

fn on_event(&mut self, watcher: SpaceWatcher)

Calls this when something happens to the space.

Provided Methods

fn is_modified(&self) -> bool

Whether anything waits for a commit.

fn refresh(&mut self)

Throws away every change and reads again from storage.

Trait Implementations

impl ObjectSpace for Box<dyn ObjectSpace>

fn entities(&self) -> Vec<EntityInfo>

The entities it knows.

fn query(&self, entity: &str, query: &Query) -> Result<Vec<Object>, SpaceError>

Reads records.

fn find(&self, entity: &str, key: &Value) -> Result<Option<Object>, SpaceError>

Reads one record by its key.

fn new_object(&mut self, entity: &str) -> Result<Object, SpaceError>

A record with what a new one starts with, kept only once saved.

fn save(&mut self, object: Object) -> Result<(), SpaceError>

Marks a record as new or changed, by its key.

fn insert(&mut self, object: Object) -> Result<(), SpaceError>

Marks a record as new, refusing a key already in use, as a form creating a record has to: it must not take over the record with that key.

fn delete(&mut self, entity: &str, key: &Value) -> Result<(), SpaceError>

Marks a record to go away.

fn changes(&self) -> Vec<Change>

What waits for a commit.

fn is_modified(&self) -> bool

Whether anything waits for a commit.

fn commit(&mut self) -> Result<(), SpaceError>

Keeps every change, or none of them.

fn rollback(&mut self)

Throws away every change.

fn refresh(&mut self)

Throws away every change and reads again from storage.

fn on_event(&mut self, watcher: SpaceWatcher)

Calls this when something happens to the space.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl ObjectSpace for Box<dyn ObjectSpace>

fn entities(&self) -> Vec<EntityInfo>

fn query(&self, entity: &str, query: &Query) -> Result<Vec<Object>, SpaceError>

fn find(&self, entity: &str, key: &Value) -> Result<Option<Object>, SpaceError>

fn new_object(&mut self, entity: &str) -> Result<Object, SpaceError>

fn save(&mut self, object: Object) -> Result<(), SpaceError>

fn insert(&mut self, object: Object) -> Result<(), SpaceError>

fn delete(&mut self, entity: &str, key: &Value) -> Result<(), SpaceError>

fn changes(&self) -> Vec<Change>

fn is_modified(&self) -> bool

fn commit(&mut self) -> Result<(), SpaceError>

fn rollback(&mut self)

fn refresh(&mut self)

fn on_event(&mut self, watcher: SpaceWatcher)

Implementors

impl ObjectSpace for AuditedObjectSpace

impl ObjectSpace for MemoryObjectSpace

impl ObjectSpace for SecuredObjectSpace