vantage-vista 2.0.0

Universal, schema-bearing data handle for the Vantage data 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

//! Rhai scripting surface over the type-erased [`Vista`](crate::vista::Vista).
//!
//! Scripts touch data through one vocabulary, [`DataVocab`]:
//!
//! - `table(name)` returns a [`Handle`], an immutable description of a set;
//!   `where`, `sort`, `search`, `limit` and `ref` narrow it into new handles
//!   (see `narrow`);
//! - read terminals (`list`, `get`, `first`, `count`, `ids`, `columns`,
//!   `references`, `capabilities`) resolve the handle and read;
//! - write terminals (`insert`, `upsert`, `patch`, `delete`, `import_from`) write
//!   to the handle's table.
//!
//! [`Terminals`] picks which terminals a host gets, and a
//! [`VistaResolver`](crate::VistaResolver) given through
//! [`DataVocab::with_resolver`] backs `table(name)`; a driver builds one over
//! its factory with [`script_tables`]. Backends add their own
//! verbs through [`TableShell::register_rhai_extensions`](crate::TableShell::register_rhai_extensions).
//! Terminal futures run through [`block_on`].
//!
//! A denied or unsupported write throws: [`Writes::Denied`] throws its
//! message, and a write the Vista refuses throws the Vista's error.
//!
//! [`run_script`] and [`preview_script`] are the agent-tool runners; the
//! `eval_*` functions evaluate YAML script slots into Vistas.

mod bridge;
mod convert;
mod eval;
mod handle;
mod import;
mod introspect;
mod lazy;
mod narrow;
mod no_rows;
mod read;
mod record;
mod runtime;
mod tables;
mod traverse;
mod vocab;
mod write;

pub use bridge::block_on;
pub use convert::{
    cbor_to_dynamic, dynamic_to_cbor, map_to_record, record_to_dynamic, record_to_map,
};
pub use eval::{eval_modify_script, eval_ref_script, reject_dropped_narrowing};
pub use handle::Handle;
pub use import::{IMPORT_CANCELLED, IMPORT_CANCELLED_SKIPPED};
pub(crate) use lazy::lazy_value_closure;
pub use record::RecordDraft;
pub use runtime::{DEFAULT_LIMIT, MAX_LIMIT, MIN_LIMIT, preview_script, run_script};
pub use tables::script_tables;
pub use vocab::{DataVocab, Terminals, Writes};

#[cfg(test)]
mod tests {
    mod bridge;
    mod capped;
    mod eval;
    mod narrow;
    mod query;
    mod runtime;
}