indexbus_kit/
prelude.rs

1//! Curated prelude for application code.
2//!
3//! This is intentionally small and boring:
4//! - errors + common helpers used in examples
5//! - lane helpers (open + wait + router runner)
6//! - typed "happy path" constructors
7//!
8//! Non-goal: re-export everything. Reach for module paths (e.g. `indexbus_kit::msg::...`) when needed.
9
10pub use crate::errors::{Error, Result};
11
12// Host-only conveniences.
13#[cfg(feature = "std")]
14pub use crate::shm::{remove_file_best_effort, temp_mmap};
15
16// Named lanes (host-only).
17#[cfg(feature = "std")]
18pub use crate::lanes::routing::{open_shm_fanout_region, spawn_shm_router, RouterThread};
19
20#[cfg(feature = "std")]
21pub use crate::lanes::sequencer::{open_shm_sequencer_region, wait_for, WaitMode};
22
23#[cfg(feature = "std")]
24pub use crate::lanes::journal::{open_shm_journal_region4, subscriber_cfg, tail_blocking};
25
26// Typed messaging.
27pub use crate::typed::{raw_codec, raw_kit, CodecKit, RawKit};
28
29// Tier-B blocking is feature-gated.
30#[cfg(feature = "blocking")]
31pub use crate::blocking::*;