Struct atomic_lib::resources::Resource

pub struct Resource { /* private fields */ }

A Resource is a set of Atoms that shares a single Subject. A Resource only contains valid Values, but it might lack required properties. All changes to the Resource are applied after committing them (e.g. by using).

Implementations

impl Resource

pub fn check_required_props(&self, store: &impl Storelike) -> AtomicResult<()>

Fetches all ‘required’ properties. Returns an error if any are missing in this Resource.

pub fn destroy(&mut self, store: &impl Storelike) -> AtomicResult<CommitResponse>

Removes / deletes the resource from the store by performing a Commit.

pub fn from_propvals(propvals: PropVals, subject: String) -> Resource

pub fn get(&self, property_url: &str) -> AtomicResult<&Value>

Get a value by property URL

pub fn get_commit_builder(&self) -> &CommitBuilder

pub fn get_classes(&self, store: &impl Storelike) -> AtomicResult<Vec<Class>>

Checks if the classes are there, if not, fetches them. Returns an empty vector if there are no classes found.

pub fn get_main_class(&self) -> AtomicResult<String>

Returns the first item of the is_ array

pub fn get_parent(&self, store: &impl Storelike) -> AtomicResult<Resource>

Returns the Parent of this Resource. Throws in case of recursion

pub fn get_parent_tree(
    &self,
    store: &impl Storelike
) -> AtomicResult<Vec<Resource>>

Walks the parent tree upwards until there is no parent, then returns them as a vector.

pub fn get_propvals(&self) -> &PropVals

Returns all PropVals. Useful if you want to iterate over all Atoms / Properties.

pub fn get_shortname(
    &self,
    shortname: &str,
    store: &impl Storelike
) -> AtomicResult<&Value>

Gets a value by its property shortname or property URL.

pub fn get_subject(&self) -> &String

pub fn has_parent(&self, store: &impl Storelike, parent: &str) -> bool

checks if a resouce has a specific parent. iterates over all parents.

pub fn into_propvals(self) -> PropVals

Returns all PropVals.

pub fn new(subject: String) -> Resource

Create a new, empty Resource.

pub fn new_generate_subject(store: &impl Storelike) -> Resource

Create a new resource with a generated Subject

pub fn new_instance(
    class_url: &str,
    store: &impl Storelike
) -> AtomicResult<Resource>

Create a new instance of some Class. The subject is generated, but can be changed. Does not save the resource to the store.

pub fn push_propval(
    &mut self,
    property: &str,
    value: SubResource,
    skip_existing: bool
) -> AtomicResult<()>

Appends a Resource to a specific property through the commitbuilder. Useful if you want to have compact Commits that add things to existing ResourceArrays.

pub fn remove_propval(&mut self, property_url: &str)

Remove a propval from a resource by property URL.

pub fn remove_propval_shortname(
    &mut self,
    property_shortname: &str,
    store: &impl Storelike
) -> AtomicResult<()>

Remove a propval from a resource by property URL or shortname. Returns error if propval does not exist in this resource or its class.

pub fn resolve_shortname_to_property(
    &self,
    shortname: &str,
    store: &impl Storelike
) -> AtomicResult<Property>

Tries to resolve the shortname of a Property to a Property. Currently only tries the shortnames for linked classes - not for other properties.

pub fn reset_commit_builder(&mut self)

pub fn save(&mut self, store: &impl Storelike) -> AtomicResult<CommitResponse>

Saves the resource (with all the changes) to the store by creating a Commit. Uses default Agent to sign the Commit. Stores changes on the Subject’s Server by sending a Commit. Returns the generated Commit, the new Resource and the old Resource.

pub fn save_locally(
    &mut self,
    store: &impl Storelike
) -> AtomicResult<CommitResponse>

Saves the resource (with all the changes) to the store by creating a Commit. Uses default Agent to sign the Commit. Returns the generated Commit and the new Resource. Does not validate rights / hierarchy. Does not store these changes on the server of the Subject - the Commit will be lost, unless you handle it manually.

pub fn set_class(&mut self, is_a: &str)

Overwrites the is_a (Class) of the Resource.

pub fn set_propval_string(
    &mut self,
    property_url: String,
    value: &str,
    store: &impl Storelike
) -> AtomicResult<()>

Insert a Property/Value combination. Overwrites existing Property/Value. Validates the datatype.

pub fn set_propval(
    &mut self,
    property: String,
    value: Value,
    store: &impl Storelike
) -> AtomicResult<()>

Inserts a Property/Value combination. Checks datatype. Overwrites existing. Adds the change to the commit builder’s set map.

pub fn set_propval_unsafe(&mut self, property: String, value: Value)

Does not validate property / datatype combination. Inserts a Property/Value combination. Overwrites existing. Adds it to the CommitBuilder.

pub fn set_propval_shortname(
    &mut self,
    property: &str,
    value: &str,
    store: &impl Storelike
) -> AtomicResult<()>

Sets a property / value combination. Property can be a shortname (e.g. ‘description’ instead of the full URL). Returns error if propval does not exist in this resource or its class.

pub fn set_propvals_unsafe(&mut self, propvals: PropVals)

Overwrites all current PropVals. Does not perform validation.

pub fn set_subject(&mut self, url: String)

Changes the subject of the Resource. Does not ‘move’ the Resource See https://github.com/atomicdata-dev/atomic-data-rust/issues/44

pub fn to_json_ad(&self) -> AtomicResult<String>

Converts Resource to JSON-AD string.

pub fn to_json(&self, store: &impl Storelike) -> AtomicResult<String>

Converts Resource to plain JSON string.

pub fn to_json_ld(&self, store: &impl Storelike) -> AtomicResult<String>

Converts Resource to JSON-LD string, with @context object and RDF compatibility.

pub fn to_atoms(&self) -> AtomicResult<Vec<Atom>>

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Resource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Resource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Resource> for SubResource

fn from(val: Resource) -> Self

Converts to this type from the input type.

impl From<Resource> for Value

fn from(val: Resource) -> Self

Converts to this type from the input type.

impl Serialize for Resource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.