tarzan 0.3.0

Random-access, seekable .tar.zst archives with an embedded table-of-contents index
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use std::collections::HashMap;
use std::path::Path;

use anyhow::Result;
use tarzan::TarzanReader;
use tarzan::format::toc::EntryType;

use crate::util::format_size;

pub fn run(archive: &Path, json: bool) -> Result<()> {
    let reader = TarzanReader::open(archive)?;

    let members = reader.members();
    let member_count = members.len();
    let regular_files = members
        .iter()
        .filter(|m| m.entry_type == EntryType::File)
        .count() as u64;
    let sha256_count = members
        .iter()
        .filter(|m| m.entry_type == EntryType::File && m.content_sha256.is_some())
        .count() as u64;
    let md5_count = members
        .iter()
        .filter(|m| m.entry_type == EntryType::File && m.content_md5.is_some())
        .count() as u64;
    let uncompressed: u64 = members
        .iter()
        .flat_map(|m| m.chunks.iter())
        .map(|c| c.uncompressed_size)
        .sum();
    // Small members can share a compressed frame, so collapse chunk records to
    // distinct frames (keyed by compressed offset) before counting and summing.
    let mut frames: HashMap<u64, u64> = HashMap::new();
    for chunk in members.iter().flat_map(|m| m.chunks.iter()) {
        frames
            .entry(chunk.compressed_offset)
            .or_insert(chunk.compressed_size);
    }
    let chunk_count = frames.len() as u64;
    let compressed: u64 = frames.values().sum();
    let archive_size = reader.archive_size();
    let toc_offset = reader.toc_offset();
    let toc_frame_size = reader.toc_frame_size();
    let identity_version = reader.identity_version();

    let ratio_value: Option<f64> =
        (uncompressed > 0).then(|| archive_size as f64 / uncompressed as f64);
    let avg_chunk_bytes: Option<u64> = (chunk_count > 0).then(|| uncompressed / chunk_count);

    if json {
        let obj = serde_json::json!({
            "format_version": identity_version,
            "identity_version": identity_version,
            "file": archive.display().to_string(),
            "size_bytes": archive_size,
            "uncompressed_bytes": uncompressed,
            "data_frame_bytes": compressed,
            "ratio": ratio_value,
            "members": member_count,
            "regular_files": regular_files,
            "content_sha256_count": sha256_count,
            "content_md5_count": md5_count,
            "chunks": chunk_count,
            "avg_chunk_size_bytes": avg_chunk_bytes,
            "toc_offset": toc_offset,
            "toc_frame_bytes": toc_frame_size,
        });
        println!("{}", serde_json::to_string_pretty(&obj)?);
        return Ok(());
    }

    let ratio = match ratio_value {
        Some(r) => format!("{:.1}%", 100.0 * r),
        None => "n/a".to_owned(),
    };
    let avg_chunk = match avg_chunk_bytes {
        Some(b) => format_size(b),
        None => "n/a".to_owned(),
    };

    println!("Format:          tarzan v{identity_version}");
    println!("File:            {}", archive.display());
    println!("Size:            {}", format_size(archive_size));
    println!("Uncompressed:    {}", format_size(uncompressed));
    println!("Ratio:           {ratio} (archive / uncompressed)");
    println!(
        "Data frames:     {} (sum of compressed frames)",
        format_size(compressed)
    );
    println!("Members:         {member_count}");
    println!(
        "content_sha256:  {}",
        checksum_summary(sha256_count, regular_files)
    );
    println!(
        "content_md5:     {}",
        checksum_summary(md5_count, regular_files)
    );
    println!("Chunks:          {chunk_count}");
    println!("Avg chunk size:  {avg_chunk} (uncompressed)");
    println!("Identity frame:  TRZN v{identity_version}");
    println!(
        "TOC frame:       {} at offset {}",
        format_size(toc_frame_size),
        toc_offset
    );

    Ok(())
}

fn checksum_summary(count: u64, regular_files: u64) -> String {
    if regular_files == 0 || count == 0 {
        "absent".to_owned()
    } else {
        format!("present ({count}/{regular_files})")
    }
}