Skip to main content

rustpix_io/
lib.rs

1//! rustpix-io: Memory-mapped file I/O for rustpix.
2//!
3//! This crate provides efficient file reading and writing using
4//! memory-mapped files via memmap2.
5//!
6#![warn(missing_docs)]
7
8mod error;
9#[cfg(feature = "hdf5")]
10pub mod hdf5;
11pub mod out_of_core;
12mod out_of_core_pipeline;
13mod reader;
14pub mod scanner;
15mod writer;
16
17pub use error::{Error, Result};
18#[cfg(feature = "hdf5")]
19pub use hdf5::{
20    write_combined_hdf5, write_combined_hdf5_batches, Hdf5HistogramSink, Hdf5HitSink,
21    Hdf5NeutronSink, HistogramAxisData, HistogramBin, PixelMaskWriteData, PixelMaskWriteOptions,
22};
23pub use out_of_core::{pulse_batches, OutOfCoreConfig, PulseBatchGroup, PulseBatcher, PulseSlice};
24pub use out_of_core_pipeline::{
25    out_of_core_neutron_stream, out_of_core_neutron_stream_handle, OutOfCoreNeutronStream,
26    OutOfCoreNeutronStreamHandle, PulseNeutronBatch, ThreadedOutOfCoreNeutronStream,
27};
28pub use reader::{
29    EventBatch, MappedFileReader, TimeOrderedEventStream, TimeOrderedHitStream, Tpx3FileReader,
30};
31pub use scanner::PacketScanner;
32pub use writer::DataFileWriter;