Skip to main content

tokio_tar/
lib.rs

1//! A library for reading and writing TAR archives in an async fashion.
2//!
3//! This library provides utilities necessary to manage [TAR archives][1]
4//! abstracted over a reader or writer. Great strides are taken to ensure that
5//! an archive is never required to be fully resident in memory, and all objects
6//! provide largely a streaming interface to read bytes from.
7//!
8//! [1]: http://en.wikipedia.org/wiki/Tar_%28computing%29
9
10// More docs about the detailed tar format can also be found here:
11// http://www.freebsd.org/cgi/man.cgi?query=tar&sektion=5&manpath=FreeBSD+8-current
12
13// NB: some of the coding patterns and idioms here may seem a little strange.
14//     This is currently attempting to expose a super generic interface while
15//     also not forcing clients to codegen the entire crate each time they use
16//     it. To that end lots of work is done to ensure that concrete
17//     implementations are all found in this crate and the generic functions are
18//     all just super thin wrappers (e.g. easy to codegen).
19
20#![deny(missing_docs)]
21#![deny(clippy::print_stderr, clippy::print_stdout)]
22#![deny(unsafe_code)]
23
24use std::io::Error;
25
26pub use crate::{
27    archive::{Archive, ArchiveBuilder, Entries},
28    builder::Builder,
29    entry::{Entry, Unpacked},
30    entry_type::EntryType,
31    error::TarError,
32    header::{
33        GnuExtSparseHeader, GnuHeader, GnuSparseHeader, Header, HeaderMode, OldHeader, UstarHeader,
34    },
35    pax::{PaxExtension, PaxExtensions},
36};
37
38mod archive;
39mod builder;
40mod entry;
41mod entry_type;
42mod error;
43mod fs;
44mod header;
45mod pax;
46
47fn other(msg: &str) -> Error {
48    Error::other(msg)
49}