singlefile_formats/lib.rs
1//! This library provides a number of default [`FileFormat`] implementations
2//! for use within [`singlefile`](https://crates.io/crates/singlefile).
3//!
4//! # Features
5//! By default, no features are enabled.
6//!
7//! - `cbor-serde`: Enables the [`Cbor`][crate::cbor_serde::Cbor] file format for use with [`serde`] types.
8//! - `json-serde`: Enables the [`Json`][crate::json_serde::Json] file format for use with [`serde`] types.
9//! - `toml-serde`: Enables the [`Toml`][crate::toml_serde::Toml] file format for use with [`serde`] types.
10//! - `bzip`: Enables the [`BZip2`][crate::bzip::BZip2] compression format. See [`CompressionFormat`] for more info.
11//! - `flate`: Enables the [`Deflate`][crate::flate::Deflate], [`Gz`][crate::flate::Gz],
12//! and [`ZLib`][crate::flate::ZLib] compression formats. See [`CompressionFormat`] for more info.
13//! - `xz`: Enables the [`Xz`][crate::xz::Xz] compression format. See [`CompressionFormat`] for more info.
14
15#![cfg_attr(docsrs, feature(doc_cfg))]
16#![forbid(unsafe_code)]
17#![warn(
18 future_incompatible,
19 missing_copy_implementations,
20 missing_debug_implementations,
21 missing_docs,
22 unreachable_pub
23)]
24
25pub extern crate singlefile;
26
27pub mod compression;
28pub mod data;