archflow 0.0.1

Create a streamable Zip archive
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

# Archflow


https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT


## Features
- Stream on the fly an archive from multiple AsyncRead objects.
- Single read / seek free implementation (the CRC and file size are calculated while streaming and are sent afterwards).
- [tokio](https://docs.rs/tokio/latest/tokio/io/index.html) `AsyncRead` / `AsyncWrite` and `AsyncSeek` compatible. 
- [std::io](https://doc.rust-lang.org/std/io/index.html) `Read` / `Write` and `Seek` compatible

Support the following compression formats:
 - stored (i.e. none)
 - deflate
 - bzip2
 - zstd
 - xz

## Todos

- implement zip64
- implement some zip features (unix time, file comments, ...)
- add more cargo features like for compressors selection

## Examples

- How to create a zip archive
- How to stream an aschive with Hyper
.

<!-- cargo-sync-readme start -->

 A library for creating ZIP archives in one pass. This is useful when when it is not possible to
 *seek* in the output such as stdout or a data stream.

 ZIP is an archive file format that supports lossless data compression. A ZIP file may contain one
 or more files or directories that may have been compressed. The ZIP file format permits a number
 of compression algorithms, though DEFLATE is the most common. This format was originally created
 in 1989 and was first implemented in PKWARE, Inc.'s PKZIP utility


 The current implementation is based on

 [PKWARE’s APPNOTE.TXT v6.3.10](https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT)

 ## Example
 ### [File system](examples/fs.rs)
```rust
 use archflow::{
 archive::FileOptions, compress::tokio::archive::ZipArchive, compression::CompressionMethod,
 error::ArchiveError,
 };

 use tokio::fs::File;

 #[tokio::main]
 async fn main() -> Result<(), ArchiveError> {
 let file = File::create("archive.zip").await?;

 let options = FileOptions::default().compression_method(CompressionMethod::Deflate());

 let mut archive = ZipArchive::new_streamable(file);
 archive.append_file("file1.txt", &mut b"hello\n".as_ref(), &options).await?;

 let options = options.compression_method(CompressionMethod::Store());
 archive.append_file("file2.txt", &mut b"world\n".as_ref(), &options).await?;

 archive.finalize().await?;

 Ok(())
 }
```
 ## Disclaimer

This implementation is inspired by :
- https://github.com/scotow/zipit and
- https://github.com/zip-rs/zip

<!-- cargo-sync-readme end -->

### [Hyper](examples/hyper.rs)