filearco 0.1.0

Simple read-only file archive format
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

//! This crate creates and reads FileArco archives.
//!
//! # Example
//!
//! This example creates a FileArco v1 archive file containing 3 text files.
//! It then opens the newly created file and outputs the text of all 3
//! stored files.
//!
//! ```rust
//! extern crate filearco;
//!
//! use std::fs::File;
//! use std::path::Path;
//!
//! // Retrieve metadata on files to archive.
//! let base_path = Path::new("testarchives/simple");
//! let file_data = filearco::get_file_data(base_path).ok().unwrap();
//!
//! // Create FileArco v1 archive file.
//! // Make sure parent directory exists first.
//! let archive_path = Path::new("tmptest/doctest_simple_v1.fac");
//! let archive_file = File::create(archive_path).ok().unwrap();
//! filearco::v1::FileArco::make(file_data, archive_file).ok().unwrap();
//!
//! // Map archive file into memory.
//! let archive = filearco::v1::FileArco::new(archive_path).ok().unwrap();
//!
//! // Retrieve and print contents of archive.
//! let cargo_toml = archive.get("Cargo.toml").unwrap();
//! println!("{}", cargo_toml.as_str().ok().unwrap());
//! let license_mit = archive.get("LICENSE-MIT").unwrap();
//! println!("{}", license_mit.as_str().ok().unwrap());
//! let license_apache = archive.get("LICENSE-APACHE").unwrap();
//! println!("{}", license_apache.as_str().ok().unwrap());
//! ```

extern crate bincode;
extern crate crc;
extern crate memmap;
extern crate page_size;
extern crate serde;
#[macro_use]
extern crate serde_derive;
extern crate walkdir;

#[cfg(test)]
extern crate memadvise;

const FILEARCO_ID: &'static [u8; 8] = b"FILEARCO";

mod file_data;
pub mod v1;

pub use file_data::{get as get_file_data, FileData, FileDataError};

use std::error;
use std::fmt;
use std::io;
use std::result;
use std::str;

/// This is the top level Error for this crate.
#[derive(Debug)]
pub enum Error {
    Io(io::Error),
    Utf8(str::Utf8Error),
    Walkdir(walkdir::Error),
    FileArcoV1(v1::FileArcoV1Error),
    FileData(FileDataError),
}

impl fmt::Display for Error {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        match self {
            &Error::Io(ref err) => err.fmt(fmt),
            &Error::Utf8(ref err) => err.fmt(fmt),
            &Error::Walkdir(ref err) => err.fmt(fmt),
            &Error::FileArcoV1(ref err) => err.fmt(fmt),
            &Error::FileData(ref err) => err.fmt(fmt),
        }
    }
}

impl error::Error for Error {
    fn description(&self) -> &str {
        match self {
            &Error::Io(ref err) => err.description(),
            &Error::Utf8(ref err) => err.description(),
            &Error::Walkdir(ref err) => err.description(),
            &Error::FileArcoV1(ref err) => err.description(),
            &Error::FileData(ref err) => err.description(),
        }
    }

    fn cause(&self) -> Option<&error::Error> {
        match self {
            &Error::Io(ref err) => err.cause(),
            &Error::Utf8(ref err) => err.cause(),
            &Error::Walkdir(ref err) => err.cause(),
            &Error::FileArcoV1(ref err) => err.cause(),
            &Error::FileData(ref err) => err.cause(),
        }
    }
}

impl From<io::Error> for Error {
    fn from(err: io::Error) -> Error {
        Error::Io(err)
    }
}

impl From<str::Utf8Error> for Error {
    fn from(err: str::Utf8Error) -> Error {
        Error::Utf8(err)
    }
}

impl From<walkdir::Error> for Error {
    fn from(err: walkdir::Error) -> Error {
        Error::Walkdir(err)
    }
}

impl From<v1::FileArcoV1Error> for Error {
    fn from(err: v1::FileArcoV1Error) -> Error {
        Error::FileArcoV1(err)
    }
}

/// This is the result type.
pub type Result<T> = result::Result<T, Error>;