k2db 0.1.1

Rust rewrite foundation for the k2db policy-enforcing MongoDB library
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

// SPDX-FileCopyrightText: 2026 Alexander R. Croft
// SPDX-License-Identifier: MIT

use mongodb::bson::Document;

use crate::options::FindOptions;
use crate::scope::Scope;

/// Typed input for `create_with`.
///
/// ```no_run
/// use k2db::CreateOp;
/// use mongodb::bson::doc;
///
/// let op = CreateOp {
///     collection: "widgets".to_owned(),
///     owner: "alice".to_owned(),
///     data: doc! { "name": "widget" },
/// };
/// # let _ = op;
/// ```
#[derive(Debug, Clone, PartialEq)]
pub struct CreateOp {
    pub collection: String,
    pub owner: String,
    pub data: Document,
}

#[derive(Debug, Clone, PartialEq)]
pub struct GetOp {
    pub collection: String,
    pub id: String,
    pub scope: Option<Scope>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct FindOneOp {
    pub collection: String,
    pub criteria: Document,
    pub fields: Option<Vec<String>>,
    pub scope: Option<Scope>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CountOp {
    pub collection: String,
    pub criteria: Document,
    pub scope: Option<Scope>,
}

/// Typed input for `find_with`.
///
/// ```no_run
/// use k2db::{FindOp, FindOptions, Scope};
/// use mongodb::bson::doc;
///
/// let op = FindOp {
///     collection: "widgets".to_owned(),
///     criteria: doc! { "status": "active" },
///     options: FindOptions::default(),
///     scope: Some(Scope::owner("alice")),
/// };
/// # let _ = op;
/// ```
#[derive(Debug, Clone, PartialEq)]
pub struct FindOp {
    pub collection: String,
    pub criteria: Document,
    pub options: FindOptions,
    pub scope: Option<Scope>,
}

/// Typed input for `aggregate_with`.
///
/// ```no_run
/// use k2db::{AggregateOp, Scope};
/// use mongodb::bson::doc;
///
/// let op = AggregateOp {
///     collection: "widgets".to_owned(),
///     pipeline: vec![doc! { "$match": { "status": "active" } }],
///     skip: 0,
///     limit: 25,
///     scope: Some(Scope::owner("alice")),
/// };
/// # let _ = op;
/// ```
#[derive(Debug, Clone, PartialEq)]
pub struct AggregateOp {
    pub collection: String,
    pub pipeline: Vec<Document>,
    pub skip: u64,
    pub limit: u64,
    pub scope: Option<Scope>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct UpdateOneOp {
    pub collection: String,
    pub id: String,
    pub data: Document,
    pub replace: bool,
    pub scope: Option<Scope>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct UpdateManyOp {
    pub collection: String,
    pub criteria: Document,
    pub values: Document,
    pub scope: Option<Scope>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct DeleteManyOp {
    pub collection: String,
    pub criteria: Document,
    pub scope: Option<Scope>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct RestoreOp {
    pub collection: String,
    pub criteria: Document,
    pub scope: Option<Scope>,
}

/// Typed input for `update_versioned_with`.
///
/// ```no_run
/// use k2db::{Scope, VersionedUpdateOp};
/// use mongodb::bson::doc;
///
/// let op = VersionedUpdateOp {
///     collection: "widgets".to_owned(),
///     id: "0194f3f3-8a34-79d0-bd03-59a59c4f3f11".to_owned(),
///     data: doc! { "name": "updated widget" },
///     replace: false,
///     max_versions: Some(10),
///     scope: Some(Scope::owner("alice")),
/// };
/// # let _ = op;
/// ```
#[derive(Debug, Clone, PartialEq)]
pub struct VersionedUpdateOp {
    pub collection: String,
    pub id: String,
    pub data: Document,
    pub replace: bool,
    pub max_versions: Option<u64>,
    pub scope: Option<Scope>,
}