hurray_io/lib.rs
1//! # hurray-io
2//!
3//! Async streaming and file format read/write for the hurray tensor interchange format.
4//!
5//! This crate builds on [`hurray_core`] and provides async I/O via Tokio.
6//!
7//! ## Feature flags
8//!
9//! | Feature | Effect |
10//! |---------|--------|
11//! | `tokio` | Enables async read/write using `tokio::io` traits |
12
13pub mod error;
14
15// Not behind the `tokio` feature: the allocation contract belongs to the format, not to
16// the async drivers, and the sans-io core (ADR-041 § 2) needs it too.
17mod aligned;
18
19pub mod file;
20
21// The stream module carries the sans-io core, which needs no runtime; only its drivers
22// are behind the `tokio` feature (ADR-041 § 1).
23pub mod stream;
24
25pub use error::{Error, Result};