s-zip 0.1.0

High-performance streaming ZIP library - Read/write ZIP files with minimal memory footprint
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132

# s-zip

[![Crates.io](https://img.shields.io/crates/v/s-zip.svg)](https://crates.io/crates/s-zip)
[![Documentation](https://docs.rs/s-zip/badge.svg)](https://docs.rs/s-zip)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

High-performance streaming ZIP library for Rust - Read/write ZIP files with minimal memory footprint.

## Features

- 🚀 **Streaming Read**: Extract files from ZIP archives without loading entire archive into memory
- ✍️ **Streaming Write**: Create ZIP files with on-the-fly compression, no temp files needed
- 💾 **Low Memory**: Constant memory usage regardless of ZIP file size
- ⚡ **Fast**: Optimized for performance with minimal allocations
- 🎯 **Simple API**: Easy to use, intuitive interface
- 📦 **No Dependencies**: Only uses `flate2` and `crc32fast`

## Quick Start

Add this to your `Cargo.toml`:

```toml
[dependencies]
s-zip = "0.1"
```

### Reading a ZIP file

```rust
use s_zip::StreamingZipReader;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut reader = StreamingZipReader::open("archive.zip")?;

    // List all entries
    for entry in reader.entries() {
        println!("{}: {} bytes", entry.name, entry.uncompressed_size);
    }

    // Read a specific file
    let data = reader.read_entry_by_name("file.txt")?;
    println!("Content: {}", String::from_utf8_lossy(&data));

    // Or use streaming for large files
    let mut stream = reader.read_entry_streaming_by_name("large_file.bin")?;
    std::io::copy(&mut stream, &mut std::io::stdout())?;

    Ok(())
}
```

### Writing a ZIP file

```rust
use s_zip::StreamingZipWriter;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut writer = StreamingZipWriter::new("output.zip")?;

    // Add first file
    writer.start_entry("file1.txt")?;
    writer.write_data(b"Hello, World!")?;

    // Add second file
    writer.start_entry("folder/file2.txt")?;
    writer.write_data(b"Another file in a folder")?;

    // Finish and write central directory
    writer.finish()?;

    Ok(())
}
```

### Custom compression level

```rust
use s_zip::StreamingZipWriter;

let mut writer = StreamingZipWriter::with_compression("output.zip", 9)?; // Max compression
// ... add files ...
writer.finish()?;
```

## Why s-zip?

Most ZIP libraries in Rust either:
- Load entire files into memory (high memory usage)
- Require temp files for compression (slow, disk I/O)
- Have complex APIs with many features you don't need

**s-zip** focuses on:
- Streaming operations (read/write on-the-fly)
- Minimal memory footprint (constant memory usage)
- Simple, easy-to-use API
- Good performance for common use cases

Perfect for:
- Processing large ZIP archives
- Creating ZIP files from streaming data
- Memory-constrained environments
- High-performance data pipelines

## Performance

- **Memory**: ~2-5 MB constant usage regardless of ZIP size
- **Speed**: Comparable to `zip` crate for common operations
- **No temp files**: Direct streaming compression saves disk I/O

## Limitations

- Only supports DEFLATE compression (most common)
- No ZIP64 support (max 4GB files) - coming soon
- No encryption support
- Write operations require `finish()` call

## License

MIT License - see [LICENSE](LICENSE) file for details.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## Related Projects

- [excelstream](https://github.com/KSD-CO/excelstream) - High-performance Excel library using s-zip
- [zip](https://crates.io/crates/zip) - Full-featured ZIP library

## Author

Ton That Vu - [@KSD-CO](https://github.com/KSD-CO)