mrc 0.2.3

Zero-copy, zero-allocation MRC-2014 file format reader/writer for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! MRC file format library for cryo-EM and tomography
//!
//! Provides iterator-centric reading and voxel-block writing with SIMD acceleration.
//!
//! # Architecture
//!
//! This crate implements a unified encoding/decoding pipeline:
//! ```text
//! Raw Bytes → Endian Normalization → Typed Values → Type Conversion
//! ```
//!
//! With zero-copy fast paths whenever possible.

#![no_std]
#![cfg_attr(feature = "f16", feature(f16))]

#[cfg(feature = "std")]
extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

mod error;
mod header;
mod iter;
mod mode;
mod reader;
mod writer;

#[cfg(feature = "mmap")]
mod mmap_reader;

mod engine;

// Re-export core types
pub use engine::block::{VolumeShape, VoxelBlock};
pub use engine::endian::FileEndian;

// Re-export codec trait for advanced users who need custom voxel types
pub use engine::codec::EndianCodec;

// Re-export conversion trait and pipeline types for type conversion
pub use engine::convert::Convert;
pub use engine::pipeline::{ConversionPath, get_conversion_path, is_zero_copy};

// Re-export SIMD batch conversions when available
#[cfg(feature = "simd")]
pub use engine::convert::{convert_i8_slice_to_f32, convert_i16_slice_to_f32, convert_u16_slice_to_f32, convert_u8_slice_to_f32, try_simd_convert};

// Re-export f16 batch conversions when f16 feature is enabled
#[cfg(feature = "f16")]
pub use engine::convert::{convert_f16_slice_to_f32, convert_f32_slice_to_f16};

// Re-export SliceAccess trait for writers
pub use engine::block::SliceAccess;

pub use error::Error;
pub use header::{ExtHeader, ExtHeaderMut, Header};
pub use mode::{Float32Complex, Int16Complex, Mode, Packed4Bit, Voxel};
pub use reader::Reader;
pub use writer::{Writer, WriterBuilder};

// Re-export conversion-enabled iterators
pub use iter::{SliceIterConverted, SlabIterConverted};

#[cfg(feature = "mmap")]
pub use writer::MmapWriter;

#[cfg(feature = "mmap")]
pub use mmap_reader::MmapReader;

/// Open an MRC file for reading
#[cfg(feature = "std")]
pub fn open(path: &str) -> Result<Reader, Error> {
    Reader::open(path)
}

/// Create a new MRC file for writing
#[cfg(feature = "std")]
pub fn create(path: &str) -> WriterBuilder {
    WriterBuilder::new(path)
}