zippity 0.4.0

Library for asynchronously creating a ZIP file on the fly.
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

# Zippity

Library for asynchronously creating a ZIP file on the fly.

[![CI](https://github.com/bluecube/zippity/actions/workflows/ci.yml/badge.svg)](https://github.com/bluecube/zippity/actions/workflows/ci.yml)
[![Docs](https://img.shields.io/docsrs/zippity/latest)](https://docs.rs/zippity)
[![Coverage Status](https://coveralls.io/repos/github/bluecube/zippity/badge.svg?branch=coveralls)](https://coveralls.io/github/bluecube/zippity?branch=coveralls)

## Features

- Async, using tokio.
- ZIP is created on the fly, can be directly streamed somewhere, does not need to be stored in RAM or on disk
- Supports Zip64 (files > 4GB).
- File size is known in advance
- Output is driven from outside (implements [`tokio::io::AsyncRead`])
- Allows seeking in the file (implements [`tokio::io::AsyncSeek`])
- Supports files on the filesystem as entries (feature `tokio-file`)
- Supports integration with Actix Web (feature `actix-web`)

## Non-features
These are not currently planned:

- Compression: The zip only uses store method.
- Encryption
- Zip reading

## Example
```rust

use std::io::SeekFrom;
use tokio::io::{AsyncSeekExt, AsyncWriteExt, copy, sink};

tokio_test::block_on(async {

// Create the builder
let mut builder = zippity::Builder::<&[u8]>::new();

// Add data
builder.add_entry("Entry name".to_owned(), b"Entry data".as_slice()).unwrap();

// Build the reader object
// Note that this does not touch the data yet.
let mut zippity = builder.build();

// Getting file size is in O(1)
println!("Total zip file size will be {}B", zippity.size());

// Seek to last 10B
zippity.seek(SeekFrom::End(-10)).await.unwrap();

// Write to output (in this case a sink, throwing it away)
copy(&mut zippity, &mut sink()).await.unwrap();

})
```

## Crate features

| Name | Description | Default |
| ---- | ----------- | ------- |
| `tokio-file` | Adds support for `FilesystemEntry` being used as a entry data, based on `Tokio::File`. | yes |
| `bytes` | Provide method `Bytes::into_bytes_stream()`. | no |
| `actix-web` | Adds`actix_web::Reponder` implementation to `zippity::Reader` | no |
| `chrono` | Support for setting last modification date and time metadata using types from `chrono`. | no |

## Current state
The library is fully functional. I'm now waiting for some experience with the final integration into
other projects (and perhaps some user feedback) before releasing stable version 1.0.