Skip to main content

fv_streams_types/
lib.rs

1//! The CONTRACT of FusionVault Streams — what every crate agrees on, and nothing more:
2//!
3//! - [`seam`]: the control-plane seam a **host** implements (`ControlPlane`, `Topology`/`StageDef`,
4//!   `Binding`) and the source/sink factories every connector and host implements (`InlineSource`,
5//!   `OutputSink`, with `SourceCtx` / `SinkCtx`);
6//! - [`contract`]: the task-facing contract a **connector or operator** implements (`Source`,
7//!   `Sink`, `Operator`, `Out`, `Poll`, the snapshot types, `EpochStaging` for exactly-once sinks);
8//! - [`decode`]: the source decode policy (declared or inferred schema, bad-data handling) and the
9//!   meta columns;
10//! - [`format`](mod@format): the message formats (JSON, Arrow IPC, raw, CSV): how a connector's messages carry
11//!   rows, with a decoder and an encoder each;
12//! - [`settings`]: the `STREAM_*` settings reader;
13//! - [`time`]: what a column's values mean as event time (epoch ms), for every reader of one.
14//!
15//! The engine (the runtime, the planner), the connectors and the SQL front door are built on top of
16//! this crate; a connector author, an embedder or a SQL tool depends on this crate alone.
17
18/// Every Rust code block in the README is compiled and run as a doctest.
19#[cfg(doctest)]
20#[doc = include_str!("../README.md")]
21pub struct ReadmeDoctests;
22
23pub mod contract;
24pub mod decode;
25pub mod field;
26pub mod format;
27pub mod options;
28pub mod seam;
29pub mod settings;
30pub mod time;
31
32pub use contract::*;
33pub use seam::*;