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
22use std::io::{Error, ErrorKind};
23
24pub use crate::{
25 archive::{Archive, ArchiveBuilder, Entries},
26 builder::Builder,
27 entry::{Entry, Unpacked},
28 entry_type::EntryType,
29 header::{
30 GnuExtSparseHeader, GnuHeader, GnuSparseHeader, Header, HeaderMode, OldHeader, UstarHeader,
31 },
32 pax::{PaxExtension, PaxExtensions},
33};
34
35mod archive;
36mod builder;
37mod entry;
38mod entry_type;
39mod error;
40mod header;
41mod pax;
42
43fn other(msg: &str) -> Error {
44 Error::new(ErrorKind::Other, msg)
45}