Skip to main content

Crate coven_foundation

Crate coven_foundation 

Source
Expand description

Coven’s clock, id source, the names its columns hold its values by, atomic file writes, store directories and locks, the watch of the device’s network, the helpers that take a lock whose holder may have panicked, and the helpers that run coven’s own work apart from its caller, turning a panic in it into a value or a report to the app’s bug sink, and its runtime shutting down into a value.

Modules§

clock
The wall clock that timestamps use (§7.2); the only reader of system time.
column_names
Coven stores some values in its tables and views as names, such as a member’s role in coven_members.role. Each value has one name. Coven writes and reads that name, and the app reads it from the column or parses it from a JSON array of the column’s values (api.md E4).
files
Files on disk: the store layout, directory, settings and exclusive lock.
id_source
New ids, including each install’s 64-bit device id (§10).
locks
Taking a lock whose holder may have panicked (api.md E15).
network_watch
The device’s network, as the platform describes it (§6.7, api.md E5).
progress
How far a long operation has come, one step at a time, so a host can draw a bar for it instead of a bare spinner (api.md E1).
sharing
Why sharing a store was refused for good (§13.2).
task
Work run apart from its caller — on the blocking pool, as its own task, or as one message of a long-lived loop — whose panic comes back to that caller as a value instead of an unwind (api.md E15).
test_work
Work measured within one test’s asynchronous and blocking calls.
uuid_text
Coven’s ids at the SQL value boundary, without database access: UUIDs as canonical text; store, key and stored objects’ ids as their sixteen bytes; and device ids as the eight big-endian bytes coven stores.

Macros§

column_names
Give the enum $type, whose values are Copy, the name each value has in coven’s columns: name() gives it, FromStr reads it, and ToSql and FromSql bind and read it as SQL text. $kind names the kind of value, such as “member role”, that UnknownName reports when FromStr finds no value with the text’s name.