aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib.rs
blob: b0d62964b800c29092bb735be74f2caa903fa579 (plain) (blame)
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
//! This crate contains helpers for reading and writing
//! [ttyrec](https://en.wikipedia.org/wiki/Ttyrec) files.
//!
//! `Parser` and `Creator` can be used to read and write files manually, and
//! `Reader` and `Writer` are helpers to provide a nicer API for asynchronous
//! applications using `tokio`.
//!
//! If you are not using `tokio`, the `tokio` dependencies can be removed by
//! building with `default_features = false` (by default, the `"async"`
//! feature is enabled which provides `tokio` support).

// XXX this is broken with ale
// #![warn(clippy::cargo)]
#![warn(clippy::pedantic)]
#![warn(clippy::nursery)]
#![allow(clippy::missing_const_for_fn)]
#![allow(clippy::multiple_crate_versions)]

mod creator;
pub use creator::Creator;
mod error;
pub use error::Error;
mod frame;
pub use frame::Frame;
mod parser;
pub use parser::Parser;
#[cfg(feature = "async")]
mod reader;
#[cfg(feature = "async")]
pub use reader::Reader;
#[cfg(feature = "async")]
mod writer;
#[cfg(feature = "async")]
pub use writer::Writer;