Struct atomic_lib::store::Store

pub struct Store { /* fields omitted */ }

The in-memory store of data, containing the Resources, Properties and Classes

Implementations

impl Store

pub fn init() -> AtomicResult<Store>

Creates an empty Store. Run .populate() to get useful standard models loaded into your store.

pub fn read_store_from_file(&self, path: &PathBuf) -> AtomicResult<()>

Reads an .ad3 (Atomic Data Triples) graph and adds it to the store

pub fn write_store_to_disk(&self, path: &PathBuf) -> AtomicResult<()>

Serializes the current store and saves to path

Trait Implementations

impl Clone for Store

pub fn clone(&self) -> Store

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Storelike for Store

pub fn add_atoms(&self, atoms: Vec<Atom>) -> AtomicResult<()>

Adds Atoms to the store. Will replace existing Atoms that share Subject / Property combination. Validates datatypes and required props presence.

pub fn add_resource(&self, resource: &Resource) -> AtomicResult<()>

Adds a Resource to the store. Replaces existing resource with the contents. In most cases, you should use .commit() instead.

pub fn add_resource_unsafe(&self, resource: &Resource) -> AtomicResult<()>

Adds a Resource to the store. Replaces existing resource with the contents. Does not do any validations.

pub fn all_resources(&self) -> ResourceCollection

Returns a collection with all resources in the store. WARNING: This could be very expensive!

pub fn get_base_url(&self) -> String

Returns the root URL where the default store is. E.g. https://example.com This is where deltas should be sent to. Also useful for Subject URL generation.

pub fn get_default_agent(&self) -> AtomicResult<Agent>

Returns the default Agent for applying commits.

pub fn get_resource(&self, subject: &str) -> AtomicResult<Resource>

Returns a full Resource with native Values. Note that this does not construct dynamic Resources, such as collections. If you're not sure what to use, use get_resource_extended.

pub fn remove_resource(&self, subject: &str)

Removes a resource from the store

pub fn set_default_agent(&self, agent: Agent)

Sets the default Agent for applying commits.

pub fn get_self_url(&self) -> Option<String>

Returns the root URL where this instance of the store is hosted. Should return None if this is simply a client and not a server. E.g. https://example.com

pub fn commit(&self, commit: Commit) -> AtomicResult<Resource> where
    Self: Sized, 

Apply a single signed Commit to the store Creates, edits or destroys a resource. Checks if the signature is created by the Agent. Should check if the Agent has the correct rights.

pub fn create_agent(&self, name: &str) -> AtomicResult<Agent>

Create an Agent, storing its public key. An Agent is required for signing Commits. Returns a tuple of (subject, private_key). Make sure to store the private_key somewhere safe! Does not create a Commit.

pub fn fetch_resource(&self, subject: &str) -> AtomicResult<Resource>

Fetches a resource, makes sure its subject matches. Save to the store.

pub fn get_class(&self, subject: &str) -> AtomicResult<Class>

Retrieves a Class from the store by subject URL and converts it into a Class useful for forms

pub fn get_classes_for_subject(&self, subject: &str) -> AtomicResult<Vec<Class>>

Finds all classes (isA) for any subject. Returns an empty vector if there are none.

pub fn get_property(&self, subject: &str) -> AtomicResult<Property>

Fetches a property by URL, returns a Property instance

pub fn get_resource_extended(&self, subject: &str) -> AtomicResult<Resource>

Get's the resource, parses the Query parameters and calculates dynamic properties. Currently only used for constructing Collections.

pub fn handle_not_found(
    &self,
    subject: &str,
    error: Box<dyn Error>
) -> AtomicResult<Resource>

pub fn tpf(
    &self,
    q_subject: Option<&str>,
    q_property: Option<&str>,
    q_value: Option<&str>
) -> AtomicResult<Vec<Atom>>

Triple Pattern Fragments interface. Use this for most queries, e.g. finding all items with some property / value combination. Returns an empty array if nothing is found.

pub fn get_path(
    &self,
    atomic_path: &str,
    mapping: Option<&Mapping>
) -> AtomicResult<PathReturn>

Accepts an Atomic Path string, returns the result value (resource or property value) E.g. https://example.com description or thing isa 0 https://docs.atomicdata.dev/core/paths.html

pub fn populate(&self) -> AtomicResult<()>

Loads the default store and constructs various default collections.

pub fn validate(&self) -> ValidationReport

Performs a light validation, without fetching external data