znippy-common 0.9.1

Core logic and data structures for Znippy, a parallel chunked compression system.
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

extern crate core;

/// Re-export arrow so plugins implement `schema_fields()` against the exact same arrow
/// version as the core trait, avoiding type-mismatch across crate boundaries.
pub use arrow;

pub mod codec;
pub mod common_config;
pub mod index;
pub mod archive;
pub mod meta_sink;

pub mod slotpool;

pub mod meta;
pub use meta::{BlobMeta, ChunkMeta, FileMeta};

pub mod plugin;
pub mod plugins;

pub mod decompress;
mod skip;

pub use archive::{ZnippyArchive, ZnippyReader};
pub use decompress::{decompress_archive, get_file};
pub use meta_sink::{ArchiveMetaSink, ArrowIpcSink, GroupKey};

pub use index::{
    ArtifactMeta, ChunkLoc, VerifyReport, ZNIPPY_INDEX_SCHEMA,
    MULTI_INDEX_MAGIC, ManifestEntry, IndexFooter,
    build_arrow_metadata_for_config, build_metadata_batch,
    extract_config_from_arrow_metadata, get_all_files_meta, get_files_meta_with_prefix,
    interpret_footer,
    is_probably_compressed, is_reserved_module, list_archive_contents, locate_file,
    read_manifest_bytes, read_znippy_index, read_znippy_manifest,
    should_skip_compression, verify_archive_integrity, write_manifest_bytes,
    znippy_index_schema,
};

#[derive(Debug)]
pub struct CompressionReport {
    pub total_files: u64,
    pub compressed_files: u64,
    pub uncompressed_files: u64,
    pub total_dirs: u64,
    pub total_bytes_in: u64,
    pub total_bytes_out: u64,
    pub compressed_bytes: u64,
    pub uncompressed_bytes: u64,
    pub compression_ratio: f32,
    pub chunks: u64,
}