dryice-bio 0.2.0

High-throughput transient container for read-like genomic records
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

//! Block header and layout metadata.

/// A byte range within a serialized block, identified by offset and length.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct ByteRange {
    /// Byte offset from the start of the block payload area.
    pub offset: u64,
    /// Length in bytes.
    pub len: u64,
}

/// Header for a single block in a `dryice` file.
///
/// Contains both the semantic metadata (codec tags, record count) and
/// the layout metadata (byte ranges for each section within the block).
/// This is a private type — users interact with blocks through the
/// reader and writer APIs.
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub(crate) struct BlockHeader {
    /// Number of records in this block.
    pub record_count: u32,

    /// Stable type tag identifying the sequence codec.
    pub sequence_codec_tag: [u8; 16],

    /// Stable type tag identifying the quality codec.
    pub quality_codec_tag: [u8; 16],

    /// Stable type tag identifying the name codec.
    pub name_codec_tag: [u8; 16],

    /// Width in bytes of the record-key section entries, or zero if absent.
    pub record_key_width: u16,

    /// Stable type tag identifying the record-key type, or all zeros if absent.
    pub record_key_tag: [u8; 16],

    /// Byte range of the record index section.
    pub index: ByteRange,

    /// Byte range of the names section, if present.
    pub names: Option<ByteRange>,

    /// Byte range of the sequences section.
    pub sequences: ByteRange,

    /// Byte range of the qualities section, if present.
    pub qualities: Option<ByteRange>,

    /// Byte range of the record-key section, if present.
    pub record_keys: Option<ByteRange>,
}