Skip to main content

Crate flyby

Crate flyby 

Source
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).
  • SimplePipeline drives source → decode → preprocess → place → sink with configurable back-pressure and runtime metrics (Part VII).
  • flyby::runtimeRuntimeConfig (TOML ≡ builder), schedulers (single-thread + worker pool), lifecycle driver, placement helpers.
  • Builder .run_demo() builds a SimplePipeline (sim → memory) when the memory feature 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

ModuleRole
core / apiTraits, errors, lifecycle, metrics
memoryShared-memory SPSC sink (feature memory, default)
netNetwork simulator + AF_XDP/DPDK stubs
storageFile source, framing, replay + io_uring/SPDK stubs
pipeline / runtime / builderComposition and execution

§Feature flags

FeatureDefaultDescription
memoryyesIn-process shared-memory sink.
af_xdpnoAF_XDP source stub (Linux eBPF / XSK).
dpdknoDPDK source stub.
io_uringnoio_uring storage backend stub.
spdknoSPDK storage backend stub.
simulatornoBuilder flag for the in-process net simulator.
benchmarksnoReserved 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 Pipeline implementation.
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.