warcat 0.3.0

Command-line tool and library for handling Web ARChive (WARC) files
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

//! Warcat: WARC Archiving Tool
//!
//! This crate provides both a library API and a binary CLI application.
//! The library can be used to read and write WARC files and
//! as well perform functions provided by the binary.
//!
//! In general cases, users working with WARC files do not need to program
//! directly with the library. The CLI application (the tool portion) is
//! designed to be part of a Unix-style pipeline.
//!
//! This documentation is for the library portion.
//! For details on the CLI, see the [user guide](https://warcat-rs.readthedocs.io/).
//!
//! The library is designed first in mind for the binary, so some parts of
//! the API will be unstable or not relevant.
//!
//! The main entrypoints to this library is [`warc::Decoder`]/[`warc::PushDecoder`] and [`warc::Encoder`].

#![cfg_attr(docsrs, feature(doc_auto_cfg))]

pub mod compress;
pub mod dataseq;
pub mod digest;
pub mod error;
pub mod extract;
pub mod fields;
pub mod header;
pub mod http;
pub mod io;
pub mod parse;
pub(crate) mod util;
pub mod verify;
pub mod warc;

#[cfg(feature = "bin")]
#[doc(hidden)]
pub mod app;