zippity 0.3.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
70
71
72
73
74
75

use crate::entry_data::{EntryData, EntrySize};
use futures_util::future::TryFutureExt;
use std::{future::Future, io::Result, path::PathBuf, pin::Pin};
use tokio::fs::{metadata, File};

pub struct TokioFileEntry(PathBuf);

impl TokioFileEntry {
    /// Construct a new file entry.
    pub fn new(path: PathBuf) -> TokioFileEntry {
        TokioFileEntry(path)
    }
}

impl From<PathBuf> for TokioFileEntry {
    fn from(path: PathBuf) -> Self {
        TokioFileEntry::new(path)
    }
}

impl EntryData for TokioFileEntry {
    // TODO: The boxed futures are ugly as ****.
    // Once `impl Trait` in associated types becomes stable,
    // we should convert to directly using those.

    type Reader = File;
    type Future = Pin<Box<dyn Future<Output = Result<File>>>>;

    fn get_reader(&self) -> Self::Future {
        Box::pin(File::open(self.0.clone()))
    }
}

impl EntrySize for TokioFileEntry {
    type Future = Pin<Box<dyn Future<Output = Result<u64>>>>;

    fn size(&self) -> Self::Future {
        Box::pin(metadata(self.0.clone()).map_ok(|m| m.len()))
    }
}

#[cfg(test)]
mod test {
    use super::*;

    use std::io::Write;
    use std::pin::pin;

    use crate::test_util::read_to_vec;
    use test_strategy::proptest;

    #[proptest(async = "tokio")]
    async fn can_determine_file_size(content: Vec<u8>) {
        let (mut tempfile, tempfile_name) = tempfile::NamedTempFile::new().unwrap().into_parts();
        tempfile.write_all(content.as_slice()).unwrap();
        drop(tempfile);

        let entry = TokioFileEntry::new(tempfile_name.to_path_buf());

        assert!(entry.size().await.unwrap() == content.len() as u64);
    }

    #[proptest(async = "tokio")]
    async fn can_read_content(content: Vec<u8>) {
        let (mut tempfile, tempfile_name) = tempfile::NamedTempFile::new().unwrap().into_parts();
        tempfile.write_all(content.as_slice()).unwrap();
        drop(tempfile);

        let entry = TokioFileEntry::new(tempfile_name.to_path_buf());

        let reader = pin!(entry.get_reader().await.unwrap());

        assert!(read_to_vec(reader, 8192).await.unwrap() == content);
    }
}