libconfig/lib.rs
1//! Serde serialization and deserialization for libconfig format
2//!
3//! This crate provides support for serializing and deserializing Rust data structures
4//! to and from the libconfig configuration file format.
5//!
6#![doc = include_str!("../README.md")]
7//!
8//! # Further Reading
9//!
10//! - [`config_api`] — full reference for the [`Config`] document wrapper
11//! - [`value_api`] — full reference for the dynamic [`Value`] type
12
13pub mod de;
14pub mod error;
15pub mod ser;
16pub mod value;
17
18pub use de::{Deserializer, from_reader, from_str};
19pub use error::{Error, ErrorKind, Result};
20pub use ser::{Serializer, WriteOptions, to_string, to_string_with_options, to_writer};
21pub use value::{Config, Map, Value, from_value, to_value};
22
23// Re-exported so `Map` (an IndexMap alias) can be constructed without a
24// separate indexmap dependency, and so the versions cannot drift
25pub use indexmap;
26
27#[doc = include_str!("../CONFIG_API.md")]
28pub mod config_api {}
29
30#[doc = include_str!("../VALUE_API.md")]
31pub mod value_api {}