d4 0.3.9

The D4 file format implementation
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

mod compression;
mod reader;
mod record;
mod record_block;

#[cfg(all(feature = "mapped_io", not(target_arch = "wasm32")))]
mod writer;

use serde_derive::{Deserialize, Serialize};

/// The metadata of the Key Value table
#[derive(Serialize, Deserialize)]
pub(crate) struct SparseArraryMetadata {
    /// The format identifier
    format: String,
    /// The record format identifier
    record_format: String,
    /// The list of partitions represented by (chromId, start, end)
    partitions: Vec<(String, u32, u32)>,
    /// The method that used for compression
    #[serde(default)]
    compression: CompressionMethod,
}

pub(crate) struct StreamInfo {
    pub(crate) id: String,
    pub(crate) chr: String,
    #[allow(dead_code)]
    pub(crate) range: (u32, u32),
}

impl SparseArraryMetadata {
    pub(crate) fn compression(&self) -> CompressionMethod {
        self.compression
    }
    pub(crate) fn streams(&self) -> impl Iterator<Item = StreamInfo> {
        self.partitions
            .clone()
            .into_iter()
            .enumerate()
            .map(|(idx, (chr, begin, end))| StreamInfo {
                id: format!("{}", idx),
                chr,
                range: (begin, end),
            })
    }
}

pub use compression::CompressionMethod;
#[cfg(all(feature = "mapped_io", not(target_arch = "wasm32")))]
pub use reader::{SparseArrayPartReader, SparseArrayReader};
#[cfg(all(feature = "mapped_io", not(target_arch = "wasm32")))]
pub use writer::{SparseArrayPartWriter, SparseArrayWriter};

pub(crate) use reader::RecordBlockParsingState;
pub use record::{RangeRecord, Record};