idiolect-records 0.6.0

Rust record types mirroring the dev.idiolect.* Lexicon family.
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

//! Rust record types mirroring the `dev.idiolect.*` Lexicon family.
//!
//! This crate's types are **generated** from the canonical lexicon
//! json in `lexicons/dev/idiolect/*.json` by `idiolect-codegen`.
//! Per the hyperdeclarative principle (P2: records-not-registries),
//! the lexicons are the single source of truth; Rust, TypeScript,
//! and SQL views are derived from them.
//!
//! Do not edit the contents of [`generated`] by hand. Re-run
//! `cargo run -p idiolect-codegen` after changing any lexicon.
//!
//! # Appview quickstart
//!
//! Every record type implements [`Record`], so indexers, xrpc
//! handlers, and tests can be generic over `R: Record`:
//!
//! ```
//! use idiolect_records::{Encounter, Record};
//! fn describe<R: Record>() -> String {
//!     format!("{} ({})", R::kind(), R::NSID)
//! }
//! assert_eq!(describe::<Encounter>(), "encounter (dev.idiolect.encounter)");
//! ```
//!
//! When the nsid is only known at runtime (e.g. firehose traffic),
//! parse it into [`Nsid`] and dispatch via [`decode_record`]:
//!
//! ```
//! use idiolect_records::{AnyRecord, decode_record, Encounter, Nsid, Record};
//! let json: serde_json::Value = serde_json::from_str(r#"{
//!   "lens":         { "uri": "at://did:plc:x/dev.idiolect.lens/1" },
//!   "sourceSchema": { "uri": "at://did:plc:x/dev.idiolect.schema/a" },
//!   "use":          { "action": "translate_source_to_target" },
//!   "kind":         "invocation-log",
//!   "visibility":   "public-detailed",
//!   "occurredAt":   "2026-04-19T00:00:00.000Z"
//! }"#).unwrap();
//! let nsid = Encounter::nsid();
//! let rec = decode_record(&nsid, json).unwrap();
//! match rec {
//!     AnyRecord::Encounter(_) => {}
//!     _ => panic!("expected encounter"),
//! }
//! ```
//!
//! Fixtures for every record kind are exported from [`examples`] for
//! use in downstream tests without reinventing minimally-valid json.

// Generated record modules under `generated/` reference the typed
// wrappers via the crate name (`idiolect_records::Did` etc.) so the
// same emitter source serves both this crate's own generated tree
// and any downstream codegen target that emits into another crate.
// `extern crate self` lets that path resolve in-crate.
extern crate self as idiolect_records;

pub mod at_uri;
pub mod cid;
pub mod datetime;
pub mod did;
pub mod family;
pub mod generated;
pub mod language;
pub mod nsid;
pub mod record;
pub mod uri;

pub use at_uri::{AtUri, AtUriError};
pub use cid::{Cid, CidError};
pub use datetime::{Datetime, DatetimeError};
pub use did::{Did, DidError, DidMethod};
pub use family::{OrAny, OrFamily, RecordFamily, detect_or_family_overlap};
pub use language::{Language, LanguageError};
pub use nsid::{Nsid, NsidError};
pub use uri::{Uri, UriError};

// Forward every type and sub-module exposed by `generated::` to the
// crate root. The list of record-type aliases lives in the generated
// `mod.rs` (one `pub use dev::...::T` per lexicon main record) so it
// stays in sync with the lexicon set without a hand-edit step.
pub use generated::*;
// `AnyRecord`, `decode_record`, and `IdiolectFamily` are codegen
// output (see `crates/idiolect-codegen/src/emit/family.rs`); the
// hand-written `record.rs` only owns the `Record` trait + `DecodeError`.
pub use generated::family::{AnyRecord, IdiolectFamily, decode_record};
pub use record::{DecodeError, Record};