ents 0.5.1

Minimal entity framework
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
112
113

use crate::{DatabaseError, Id};

/// Sort order for edge queries
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SortOrder {
    /// Ascending order (smallest to largest)
    Asc,
    /// Descending order (largest to smallest)
    Desc,
}

/// Cursor for pagination combining sort key and destination
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EdgeCursor<'a> {
    /// The sort key value at the cursor position
    pub sort_key: &'a [u8],
    /// The destination ID at the cursor position
    pub destination: Id,
}

impl<'a> EdgeCursor<'a> {
    /// Create a new cursor
    pub fn new(sort_key: &'a [u8], destination: Id) -> Self {
        Self {
            sort_key,
            destination,
        }
    }
}

/// Edge result containing all three properties
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Edge {
    /// Source entity ID
    pub source: Id,
    /// Sort key for ordering
    pub sort_key: Vec<u8>,
    /// Destination entity ID
    pub dest: Id,
}

impl Edge {
    /// Create a new edge
    pub fn new(source: Id, sort_key: Vec<u8>, dest: Id) -> Self {
        Self {
            source,
            sort_key,
            dest,
        }
    }
}

/// Result of an edge query, containing edges and pagination info
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EdgeQueryResult {
    /// The edges returned by the query
    pub edges: Vec<Edge>,
    /// Whether there are more edges beyond those returned
    pub has_more: bool,
}

/// Query parameters for edge enumeration
#[derive(Debug, Clone)]
pub struct EdgeQuery<'a> {
    /// Filter edges by name (IN clause). If empty, no name filtering is applied.
    pub edge_names: &'a [&'a [u8]],
    /// Sort order for results
    pub order: SortOrder,
    /// Cursor for pagination:
    /// - For Asc order: returns edges with (sort_key, destination) > cursor
    /// - For Desc order: returns edges with (sort_key, destination) < cursor
    pub cursor: Option<EdgeCursor<'a>>,
}

impl<'a> EdgeQuery<'a> {
    /// Create a new query with ascending order
    pub fn asc(edge_names: &'a [&'a [u8]]) -> Self {
        Self {
            edge_names,
            order: SortOrder::Asc,
            cursor: None,
        }
    }

    /// Create a new query with descending order
    pub fn desc(edge_names: &'a [&'a [u8]]) -> Self {
        Self {
            edge_names,
            order: SortOrder::Desc,
            cursor: None,
        }
    }

    /// Set the pagination cursor
    pub fn with_cursor(mut self, cursor: EdgeCursor<'a>) -> Self {
        self.cursor = Some(cursor);
        self
    }

    pub fn with_cursor_opt(mut self, cursor: Option<EdgeCursor<'a>>) -> Self {
        self.cursor = cursor;
        self
    }
}

pub trait QueryEdge {
    /// Find edges
    fn find_edges(
        &self,
        source: Id,
        query: EdgeQuery,
    ) -> Result<EdgeQueryResult, DatabaseError>;
}