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() -> Store

Create an empty Store. This is where you start.

Example

let store = Store::init();

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

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

pub fn write_store_to_disk(&mut 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<()>

Add individual Atoms to the store. Will replace existing Atoms that share Subject / Property combination.

pub fn add_resource_string(
    &self,
    subject: String,
    resource: &ResourceString
) -> AtomicResult<()>

Replaces existing resource with the contents Accepts a simple nested string only hashmap Adds to hashmap and to the resource store

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 store is hosted. E.g. https://example.com This is where deltas should be sent to. Also useful for Subject URL generation.

pub fn get_resource_string(
    &self,
    resource_url: &str
) -> AtomicResult<ResourceString>

Returns a hashmap ResourceString with string Values. Fetches the resource if it is not in the store.

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

Removes a resource from the store

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

Apply a single 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 add_resource(&self, resource: &Resource<'_>) -> AtomicResult<()>

Adds a Resource to the store

pub fn create_agent(&self, name: &str) -> AtomicResult<(String, String)> where
    Self: Sized, 

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!

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

Fetches a resource, makes sure its subject matches. Save to the store. Only adds atoms with matching subjects will be added.

pub fn get_resource(&self, subject: &str) -> AtomicResult<Resource<'_>> where
    Self: Sized, 

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 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 new_collection(
    &self,
    collection_builder: CollectionBuilder
) -> AtomicResult<Collection> where
    Self: Sized, 

Constructs a Collection, which is a paginated list of items with some sorting applied.

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

Fetches a property by URL, returns a Property instance

pub fn get_resource_extended(&self, subject: &str) -> AtomicResult<Resource<'_>> where
    Self: Sized, 

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

pub fn add_atom(&self, atom: Atom) -> AtomicResult<()>

Adds an atom to the store. Does not do any validations

pub fn process_delta(&self, delta: DeltaDeprecated) -> AtomicResult<()>

DEPRECATED - PREFER COMMITS Processes a vector of deltas and updates the store.

pub fn property_shortname_to_url(
    &self,
    shortname: &str,
    resource: &ResourceString
) -> AtomicResult<String>

Finds the URL of a shortname used in the context of a specific Resource. The Class, Properties and Shortnames of the Resource are used to find this URL

pub fn property_url_to_shortname(&self, url: &str) -> AtomicResult<String>

Finds the shortname for some property URL

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> where
    Self: Sized, 

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<()> where
    Self: Sized, 

Loads the default store. Constructs various default collections.

pub fn validate(&self) -> ValidationReport where
    Self: Sized, 

Performs a light validation, without fetching external data