Expand description
§flyby
Public crate of the FlyBy framework. Exposes flyby::core, portable
flyby::net / flyby::storage types, the optional shared-memory sink
(flyby::memory), and the runtime / builder API.
§Status
- Builder
.run()validates feature selection (skeleton). SimplePipelinedrives source → decode → preprocess → place → sink with configurable back-pressure and runtime metrics (Part VII).flyby::runtime—RuntimeConfig(TOML ≡ builder), schedulers (single-thread + worker pool), lifecycle driver, placement helpers.- Builder
.run_demo()builds aSimplePipeline(sim → memory) when thememoryfeature is enabled. - Multi-sink type-state builder remains incremental work.
§Docs
- Project guide:
docs/src/runtime.md - ADR-009 / ADR-010: batch-oriented runtime; runtime independent of backends
§flyby
High-performance composable data-ingestion pipelines.
use flyby::prelude::*;§Crate layout
| Module | Role |
|---|---|
core / api | Traits, errors, lifecycle, metrics |
memory | Shared-memory SPSC sink (feature memory, default) |
net | Network simulator + AF_XDP/DPDK stubs |
storage | File source, framing, replay + io_uring/SPDK stubs |
pipeline / runtime / builder | Composition and execution |
§Feature flags
| Feature | Default | Description |
|---|---|---|
memory | yes | In-process shared-memory sink. |
af_xdp | no | AF_XDP source stub (Linux eBPF / XSK). |
dpdk | no | DPDK source stub. |
io_uring | no | io_uring storage backend stub. |
spdk | no | SPDK storage backend stub. |
simulator | no | Builder flag for the in-process net simulator. |
benchmarks | no | Reserved for optional bench wiring. |
§Runtime (Part VII)
See runtime for scheduling, back-pressure, configuration, and the
lifecycle driver. ADRs: batch-oriented runtime (009), runtime independent
of backends (010).
Re-exports§
pub use api::*;
Modules§
- api
- Core traits, errors, and lifecycle (alias of
core). - builder
- The builder API for composing a FlyBy pipeline.
- core
- Contract layer: traits, errors, lifecycle, and metrics.
- memory
- Shared-memory sink (default backend).
- net
- Networking backends (simulator always; AF_XDP/DPDK behind features).
- pipeline
- Minimal concrete
Pipelineimplementation. - prelude
- The public prelude.
- runtime
- Part VII runtime: scheduling, configuration, back-pressure, and telemetry.
- storage
- Storage backends (file/framing/replay always; io_uring/SPDK behind features). Storage backends for the FlyBy framework.