text-document-common 1.4.0

Shared entities, database, events, and undo/redo infrastructure for text-document
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

// Generated by Qleany v1.5.0 from common_da_use_cases_traits.tera

use crate::database::{CommandUnitOfWork, QueryUnitOfWork};
use crate::snapshot::EntityTreeSnapshot;
use crate::types::{EntityId, HasId};
use anyhow::Result;
use std::collections::HashMap;

// ---------------------------------------------------------------------------
// Read-only UoW traits
// ---------------------------------------------------------------------------

pub trait ReadUoW: QueryUnitOfWork {
    type Entity;

    fn get(&self, id: &EntityId) -> Result<Option<Self::Entity>>;
    fn get_multi(&self, ids: &[EntityId]) -> Result<Vec<Option<Self::Entity>>>;
    fn get_all(&self) -> Result<Vec<Self::Entity>>;
}

pub trait ReadUoWFactory {
    type Entity;
    fn create(&self) -> Box<dyn ReadUoW<Entity = Self::Entity>>;
}

// ---------------------------------------------------------------------------
// Write UoW traits
// ---------------------------------------------------------------------------

pub trait WriteUoW: CommandUnitOfWork {
    type Entity: Clone + HasId + Send;

    fn get(&self, id: &EntityId) -> Result<Option<Self::Entity>>;
    fn get_multi(&self, ids: &[EntityId]) -> Result<Vec<Option<Self::Entity>>>;
    fn get_all(&self) -> Result<Vec<Self::Entity>>;
    fn create_orphan_multi(&self, entities: &[Self::Entity]) -> Result<Vec<Self::Entity>>;
    fn update_multi(&self, entities: &[Self::Entity]) -> Result<Vec<Self::Entity>>;
    fn update_with_relationships_multi(
        &self,
        entities: &[Self::Entity],
    ) -> Result<Vec<Self::Entity>>;
    fn remove(&self, id: &EntityId) -> Result<()>;
    fn remove_multi(&self, ids: &[EntityId]) -> Result<()>;
    fn snapshot(&self, ids: &[EntityId]) -> Result<EntityTreeSnapshot>;
    fn restore(&self, snap: &EntityTreeSnapshot) -> Result<()>;
}

pub trait WriteUoWFactory: Send + Sync {
    type Entity: Clone + HasId + Send;
    fn create(&self) -> Box<dyn WriteUoW<Entity = Self::Entity>>;
}

// ---------------------------------------------------------------------------
// Owned-entity write UoW traits (entities with an owner)
// ---------------------------------------------------------------------------

pub trait OwnedWriteUoW: WriteUoW {
    fn create_multi(
        &self,
        entities: &[Self::Entity],
        owner_id: EntityId,
        index: i32,
    ) -> Result<Vec<Self::Entity>>;
    fn get_relationships_from_owner(&self, owner_id: &EntityId) -> Result<Vec<EntityId>>;
    fn set_relationships_in_owner(&self, owner_id: &EntityId, ids: &[EntityId]) -> Result<()>;
}

pub trait OwnedWriteUoWFactory: Send + Sync {
    type Entity: Clone + HasId + Send;
    fn create(&self) -> Box<dyn OwnedWriteUoW<Entity = Self::Entity>>;
}

// ---------------------------------------------------------------------------
// Relationship UoW traits
// ---------------------------------------------------------------------------

pub trait ReadRelUoW<RF>: QueryUnitOfWork {
    fn get_relationship(&self, id: &EntityId, field: &RF) -> Result<Vec<EntityId>>;
    fn get_relationship_many(
        &self,
        ids: &[EntityId],
        field: &RF,
    ) -> Result<HashMap<EntityId, Vec<EntityId>>>;
    fn get_relationship_count(&self, id: &EntityId, field: &RF) -> Result<usize>;
    fn get_relationship_in_range(
        &self,
        id: &EntityId,
        field: &RF,
        offset: usize,
        limit: usize,
    ) -> Result<Vec<EntityId>>;
}

pub trait ReadRelUoWFactory<RF> {
    fn create(&self) -> Box<dyn ReadRelUoW<RF>>;
}

pub trait WriteRelUoW<RF>: CommandUnitOfWork {
    fn set_relationship(&self, id: &EntityId, field: &RF, right_ids: &[EntityId]) -> Result<()>;
    fn move_relationship(
        &self,
        id: &EntityId,
        field: &RF,
        ids_to_move: &[EntityId],
        new_index: i32,
    ) -> Result<Vec<EntityId>>;
}

pub trait WriteRelUoWFactory<RF>: Send + Sync {
    fn create(&self) -> Box<dyn WriteRelUoW<RF>>;
}