stelae 0.4.2

A collection of tools in Rust and Python for preserving, authenticating, and accessing laws in perpetuity.
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

use super::version::Version;
use async_trait::async_trait;
use serde::{Deserialize, Serialize};

pub mod manager;

/// Trait for managing document changes.
#[async_trait]
pub trait Manager {
    /// All dates on which given document changed.
    async fn find_all_document_versions_by_mpath_and_publication(
        &self,
        mpath: &str,
        publication: &str,
    ) -> anyhow::Result<Vec<Version>>;
}

/// Trait for managing transactional document changes.
#[async_trait]
pub trait TxManager {
    /// Insert a bulk of document changes.
    async fn insert_bulk(&mut self, document_changes: Vec<DocumentChange>) -> anyhow::Result<()>;
}

#[derive(sqlx::FromRow, Deserialize, Serialize)]
/// Model for document change events.
pub struct DocumentChange {
    /// A hashed identifier for the document change.
    /// The hash is generated from the `publication_version` id, `doc_mpath`, and `status` (as integer) field.
    pub id: String,
    /// Change status of the document.
    /// Currently could be 'Element added' = 0, 'Element effective' = 1, 'Element changed' = 2 or 'Element removed' = 3.
    pub status: i64,
    /// Optional reason for the change event.
    pub change_reason: Option<String>,
    /// Foreign key reference to the `publication_version` id.
    pub publication_version_id: String,
    /// Materialized path to the document
    pub doc_mpath: String,
}

impl DocumentChange {
    /// Create a new document change.
    #[must_use]
    pub const fn new(
        id: String,
        status: i64,
        change_reason: Option<String>,
        publication_version_id: String,
        doc_mpath: String,
    ) -> Self {
        Self {
            id,
            status,
            change_reason,
            publication_version_id,
            doc_mpath,
        }
    }
}