netidx-container 0.31.1

netidx embeddable database
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
use anyhow::Result;
use arcstr::ArcStr;
use futures::channel::mpsc;
use netidx::{path::Path, publisher::Publisher, subscriber::Value, utils::Batched};
use netidx_protocols::rpc::server::{ArgSpec, Proc, RpcCall, RpcReply};

pub(super) enum RpcRequestKind {
    Delete(Path),
    DeleteSubtree(Path),
    LockSubtree(Path),
    UnlockSubtree(Path),
    SetData {
        path: Path,
        value: Value,
    },
    CreateSheet {
        path: Path,
        rows: usize,
        columns: usize,
        max_rows: usize,
        max_columns: usize,
        lock: bool,
    },
    AddSheetRows(Path, usize),
    AddSheetCols(Path, usize),
    DelSheetRows(Path, usize),
    DelSheetCols(Path, usize),
    CreateTable {
        path: Path,
        rows: Vec<ArcStr>,
        columns: Vec<ArcStr>,
        lock: bool,
    },
    AddTableRows(Path, Vec<ArcStr>),
    AddTableCols(Path, Vec<ArcStr>),
    DelTableRows(Path, Vec<ArcStr>),
    DelTableCols(Path, Vec<ArcStr>),
    AddRoot(Path),
    DelRoot(Path),
    Packed(Vec<Self>),
}

pub(super) struct RpcRequest {
    pub(super) kind: RpcRequestKind,
    pub(super) reply: RpcReply,
}

pub(super) struct RpcApi {
    _delete_path_rpc: Proc,
    _delete_subtree_rpc: Proc,
    _lock_subtree_rpc: Proc,
    _unlock_subtree_rpc: Proc,
    _set_data_rpc: Proc,
    _create_sheet_rpc: Proc,
    _add_sheet_rows: Proc,
    _add_sheet_cols: Proc,
    _del_sheet_rows: Proc,
    _del_sheet_cols: Proc,
    _create_table_rpc: Proc,
    _add_table_rows: Proc,
    _add_table_cols: Proc,
    _del_table_rows: Proc,
    _del_table_cols: Proc,
    _add_root: Proc,
    _del_root: Proc,
    pub(super) rx: Batched<mpsc::Receiver<RpcRequest>>,
}

impl RpcApi {
    pub(super) fn new(publisher: &Publisher, base_path: &Path) -> Result<RpcApi> {
        let (tx, rx) = mpsc::channel(10);
        let _delete_path_rpc = start_delete_rpc(&publisher, &base_path, tx.clone())?;
        let _delete_subtree_rpc =
            start_delete_subtree_rpc(&publisher, &base_path, tx.clone())?;
        let _lock_subtree_rpc =
            start_lock_subtree_rpc(&publisher, &base_path, tx.clone())?;
        let _unlock_subtree_rpc =
            start_unlock_subtree_rpc(&publisher, &base_path, tx.clone())?;
        let _set_data_rpc = start_set_data_rpc(&publisher, &base_path, tx.clone())?;
        let _create_sheet_rpc =
            start_create_sheet_rpc(&publisher, &base_path, tx.clone())?;
        let _add_sheet_rows =
            start_add_sheet_rows_rpc(&publisher, &base_path, tx.clone())?;
        let _add_sheet_cols =
            start_add_sheet_cols_rpc(&publisher, &base_path, tx.clone())?;
        let _del_sheet_rows =
            start_del_sheet_rows_rpc(&publisher, &base_path, tx.clone())?;
        let _del_sheet_cols =
            start_del_sheet_cols_rpc(&publisher, &base_path, tx.clone())?;
        let _create_table_rpc =
            start_create_table_rpc(&publisher, &base_path, tx.clone())?;
        let _add_table_rows =
            start_add_table_rows_rpc(&publisher, &base_path, tx.clone())?;
        let _add_table_cols =
            start_add_table_cols_rpc(&publisher, &base_path, tx.clone())?;
        let _del_table_rows =
            start_del_table_rows_rpc(&publisher, &base_path, tx.clone())?;
        let _del_table_cols =
            start_del_table_cols_rpc(&publisher, &base_path, tx.clone())?;
        let _add_root = start_add_root_rpc(&publisher, &base_path, tx.clone())?;
        let _del_root = start_del_root_rpc(&publisher, &base_path, tx.clone())?;
        Ok(RpcApi {
            _delete_path_rpc,
            _delete_subtree_rpc,
            _lock_subtree_rpc,
            _unlock_subtree_rpc,
            _set_data_rpc,
            _create_sheet_rpc,
            _add_sheet_rows,
            _add_sheet_cols,
            _del_sheet_rows,
            _del_sheet_cols,
            _create_table_rpc,
            _add_table_rows,
            _add_table_cols,
            _del_table_rows,
            _del_table_cols,
            _add_root,
            _del_root,
            rx: Batched::new(rx, 1_000_000),
        })
    }
}

fn start_path_arg_rpc(
    publisher: &Publisher,
    base_path: &Path,
    name: &'static str,
    doc: &'static str,
    argdoc: &'static str,
    f: fn(Path) -> RpcRequestKind,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    let map = move |mut c: RpcCall, mut path: Vec<Path>| -> Option<RpcRequest> {
        if path.len() == 0 {
            rpc_err!(c.reply, "expected at least 1 path")
        } else if path.len() == 1 {
            Some(RpcRequest { kind: f(path.pop().unwrap()), reply: c.reply })
        } else {
            let reqs = path.into_iter().map(f).collect();
            Some(RpcRequest { kind: RpcRequestKind::Packed(reqs), reply: c.reply })
        }
    };
    define_rpc!(
        publisher,
        base_path.append(name),
        doc,
        map,
        Some(tx),
        path: Vec<Path> = Vec::<Path>::new(); argdoc
    )
}

pub(super) fn start_delete_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    start_path_arg_rpc(
        publisher,
        base_path,
        "delete",
        "delete path(s) from the database",
        "the path(s) to delete",
        RpcRequestKind::Delete,
        tx,
    )
}

pub(super) fn start_delete_subtree_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    start_path_arg_rpc(
        publisher,
        base_path,
        "delete-subtree",
        "delete subtree(s) from the database",
        "the subtree(s) to delete",
        RpcRequestKind::DeleteSubtree,
        tx,
    )
}

pub(super) fn start_lock_subtree_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    start_path_arg_rpc(
        publisher,
        base_path,
        "lock-subtree",
        "lock subtree(s) so only rpc calls can create/delete values there",
        "the subtree(s) to lock",
        RpcRequestKind::LockSubtree,
        tx,
    )
}

pub(super) fn start_unlock_subtree_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    start_path_arg_rpc(
        publisher,
        base_path,
        "unlock-subtree",
        "unlock subtree(s) so the default publisher can create values",
        "the subtree(s) to unlock",
        RpcRequestKind::UnlockSubtree,
        tx,
    )
}

pub(super) fn start_add_root_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    start_path_arg_rpc(
        publisher,
        base_path,
        "add-root",
        "add a new root to the container",
        "the root(s) to add",
        RpcRequestKind::AddRoot,
        tx,
    )
}

pub(super) fn start_del_root_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    start_path_arg_rpc(
        publisher,
        base_path,
        "remove-root",
        "remove a root and all it's children",
        "the root(s) to remove",
        RpcRequestKind::DelRoot,
        tx,
    )
}

pub(super) fn start_set_data_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(mut c: RpcCall, mut path: Vec<Path>, value: Value) -> Option<RpcRequest> {
        if path.len() == 0 {
            rpc_err!(c.reply, "expected at least 1 path")
        } else if path.len() == 1 {
            Some(RpcRequest {
                reply: c.reply,
                kind: RpcRequestKind::SetData { path: path.pop().unwrap(), value },
            })
        } else {
            let reqs = path
                .into_iter()
                .map(|path| RpcRequestKind::SetData { path, value: value.clone() })
                .collect();
            Some(RpcRequest { reply: c.reply, kind: RpcRequestKind::Packed(reqs) })
        }
    }
    define_rpc!(
        publisher,
        base_path.append("set-data"),
        "make the specified paths data and optionally set the value",
        map,
        Some(tx),
        path: Vec<Path> = Vec::<Path>::new(); "the paths to set",
        value: Value = Value::Null; "The value to set"
    )
}

pub(super) fn start_create_sheet_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(
        c: RpcCall,
        path: Path,
        rows: usize,
        columns: usize,
        max_rows: Option<usize>,
        max_columns: Option<usize>,
        lock: bool,
    ) -> Option<RpcRequest> {
        let max_rows =
            max_rows.unwrap_or_else(|| 10f32.powf(1. + (rows as f32).log10()) as usize);
        let max_columns = max_columns
            .unwrap_or_else(|| 10f32.powf(1. + (columns as f32).log10()) as usize);
        let kind = RpcRequestKind::CreateSheet {
            path,
            rows,
            columns,
            max_rows,
            max_columns,
            lock,
        };
        Some(RpcRequest { reply: c.reply, kind })
    }
    define_rpc!(
        publisher,
        base_path.append("create-sheet"),
        "create a spreadsheet like sheet",
        map,
        Some(tx),
        path: Path = Value::Null; "where to put the sheet",
        rows: usize = 1; "the number of rows",
        columns: usize = 1; "the number of columns",
        max_rows: Option<usize> = None::<u64>; "the maximum number of rows",
        max_columns: Option<usize> = None::<u64>; "the maximum number of columns",
        lock: bool = true; "lock the sheet subtree"
    )
}

pub(super) fn start_add_sheet_rows_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(c: RpcCall, path: Path, rows: usize) -> Option<RpcRequest> {
        let kind = RpcRequestKind::AddSheetRows(path, rows);
        Some(RpcRequest { reply: c.reply, kind })
    }
    define_rpc!(
        publisher,
        base_path.append("add-sheet-rows"),
        "add rows to a previously created sheet",
        map,
        Some(tx),
        path: Path = Value::Null; "the sheet to modify",
        rows: usize = Value::Null; "the number of rows to add"
    )
}

pub(super) fn start_add_sheet_cols_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(c: RpcCall, path: Path, columns: usize) -> Option<RpcRequest> {
        let kind = RpcRequestKind::AddSheetCols(path, columns);
        Some(RpcRequest { kind, reply: c.reply })
    }
    define_rpc!(
        publisher,
        base_path.append("add-sheet-columns"),
        "add columns to a previously created sheet",
        map,
        Some(tx),
        path: Path = Value::Null; "the sheet to modify",
        columns: usize = Value::Null; "the number of columns to add"
    )
}

pub(super) fn start_del_sheet_rows_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(c: RpcCall, path: Path, rows: usize) -> Option<RpcRequest> {
        let kind = RpcRequestKind::DelSheetRows(path, rows);
        Some(RpcRequest { kind, reply: c.reply })
    }
    define_rpc!(
        publisher,
        base_path.append("delete-sheet-rows"),
        "delete rows in a previously created sheet",
        map,
        Some(tx),
        path: Path = Value::Null; "the sheet to modify",
        rows: usize = Value::Null; "the number of rows to add"
    )
}

pub(super) fn start_del_sheet_cols_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(c: RpcCall, path: Path, columns: usize) -> Option<RpcRequest> {
        let kind = RpcRequestKind::DelSheetCols(path, columns);
        Some(RpcRequest { kind, reply: c.reply })
    }
    define_rpc!(
        publisher,
        base_path.append("delete-sheet-columns"),
        "delete columns in a previously created sheet",
        map,
        Some(tx),
        path: Path = Value::Null; "the sheet to modify",
        columns: usize = Value::Null; "number of columns to delete"
    )
}

pub(super) fn start_create_table_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(
        c: RpcCall,
        path: Path,
        rows: Vec<ArcStr>,
        columns: Vec<ArcStr>,
        lock: bool,
    ) -> Option<RpcRequest> {
        let kind = RpcRequestKind::CreateTable { path, rows, columns, lock };
        Some(RpcRequest { kind, reply: c.reply })
    }
    define_rpc!(
        publisher,
        base_path.append("create-table"),
        "create a database like table",
        map,
        Some(tx),
        path: Path = Value::Null; "where to put the table",
        rows: Vec<ArcStr> = Value::Null; "the row names",
        columns: Vec<ArcStr> = Value::Null; "the column names",
        lock: bool = true; "lock the table subtree"
    )
}

pub(super) fn start_add_table_rows_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(c: RpcCall, path: Path, rows: Vec<ArcStr>) -> Option<RpcRequest> {
        let kind = RpcRequestKind::AddTableRows(path, rows);
        Some(RpcRequest { kind, reply: c.reply })
    }
    define_rpc!(
        publisher,
        base_path.append("add-table-rows"),
        "add rows to a table",
        map,
        Some(tx),
        path: Path = Value::Null; "the table to modify",
        rows: Vec<ArcStr> = Value::Null; "the rows to add"
    )
}

pub(super) fn start_add_table_cols_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(c: RpcCall, path: Path, columns: Vec<ArcStr>) -> Option<RpcRequest> {
        let kind = RpcRequestKind::AddTableCols(path, columns);
        Some(RpcRequest { reply: c.reply, kind })
    }
    define_rpc!(
        publisher,
        base_path.append("add-table-columns"),
        "add columns to a table",
        map,
        Some(tx),
        path: Path = Value::Null; "the table to modify",
        columns: Vec<ArcStr> = Value::Null; "the columns to add"
    )
}

pub(super) fn start_del_table_rows_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(c: RpcCall, path: Path, rows: Vec<ArcStr>) -> Option<RpcRequest> {
        let kind = RpcRequestKind::DelTableRows(path, rows);
        Some(RpcRequest { reply: c.reply, kind })
    }
    define_rpc!(
        publisher,
        base_path.append("delete-table-rows"),
        "delete rows from a table",
        map,
        Some(tx),
        path: Path = Value::Null; "the table to modify",
        rows: Vec<ArcStr> = Value::Null; "the rows to delete"
    )
}

pub(super) fn start_del_table_cols_rpc(
    publisher: &Publisher,
    base_path: &Path,
    tx: mpsc::Sender<RpcRequest>,
) -> Result<Proc> {
    fn map(c: RpcCall, path: Path, columns: Vec<ArcStr>) -> Option<RpcRequest> {
        let kind = RpcRequestKind::DelTableCols(path, columns);
        Some(RpcRequest { reply: c.reply, kind })
    }
    define_rpc!(
        publisher,
        base_path.append("delete-table-columns"),
        "delete columns from a table",
        map,
        Some(tx),
        path: Path = Value::Null; "the table to modify",
        columns: Vec<ArcStr> = Value::Null; "the columns to delete"
    )
}