ligature 0.8.0

Ligature's data model in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

//! This module contains Ligature's data model in Rust.

#![deny(missing_docs)]

use hashbag::HashBag;
use std::collections::{BTreeMap, BTreeSet};
use serde::{Deserialize, Serialize};

/// An Element that is identified by a unique String value.
#[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq, Deserialize, Serialize, Hash)]
pub struct Element(pub String);

/// A single entry in a Network.
#[derive(Debug, Clone, PartialOrd, Ord, PartialEq, Eq, Deserialize, Serialize, Hash)]
pub enum Entry {
    /// A relationship between two Elements.
    Role {
        /// The first Element.
        first: Element,
        /// The second Element.
        second: Element,
        /// The Role between the two Elements.
        role: Element,
    },
    /// Represens an Element extending a Concept.
    Extends {
        /// The Element.
        element: Element,
        /// The Concept the Element extends.
        concept: Element,
    },
    /// Represens an Element not extending a Concept.
    NotExtends {
        /// The Element.
        element: Element,
        /// The Concept the Element does not extend.
        concept: Element,
    },
}

/// A simple error message.
pub struct LigatureError(pub String);

/// A trait that defines all the actions a Ligature instance can perform.
/// The API used for storing triples.
pub trait Ligature {
    /// Get all Collections.
    fn collections(&self) -> Result<Vec<Element>, LigatureError>;

    /// Add a new Dataset.
    /// Does nothing if Dataset already exists.
    fn add_collection(&mut self, collection: Element) -> Result<(), LigatureError>;

    /// Remove a Dataset.
    /// Does nothing if Dataset doesn't exist.
    fn remove_collection(&mut self, collection: Element) -> Result<(), LigatureError>;

    /// Get all Statements in a given Dataset.
    fn entries(&self, collection: Element) -> Result<BTreeSet<Entry>, LigatureError>;

    /// Add Statements to a given Dataset.
    /// Returns Error if Dataset doesn't exist.
    /// Does nothing if Statement already exists in Dataset.
    fn add_entries(&mut self, collection: Element, entries: &mut BTreeSet<Entry>) -> Result<(), LigatureError>;
    /// Remove Statements from a given Dataset.
    /// Returns Error if Dataset doesn't exist.
    /// Does nothing if Statement doesn't exist in Dataset.
    fn remove_entries(
        &mut self,
        collection: Element,
        entries: &mut BTreeSet<Entry>,
    ) -> Result<(), LigatureError>;
    /// Run a query against the given Dataset.
    fn query(
        &self,
        collection: Element,
        pattern: BTreeSet<Entry>,
    ) -> Result<HashBag<BTreeMap<String, String>>, LigatureError>;
}