table/lib.rs
1// Copyright (C) 2018 Project Tsukurou!
2//
3// This program is free software: you can redistribute it and/or modify
4// it under the terms of the GNU General Public License as published by
5// the Free Software Foundation, either version 3 of the License, or
6// (at your option) any later version.
7//
8// This program is distributed in the hope that it will be useful,
9// but WITHOUT ANY WARRANTY; without even the implied warranty of
10// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11// GNU General Public License for more details.
12//
13// You should have received a copy of the GNU General Public License
14// along with this program. If not, see <https://www.gnu.org/licenses/>.
15
16//! Tables are a special type of map that store named values of varying types.
17//!
18//! This is extremely useful for storing arbitrary configuration or data, as
19//! many common file formats (like JSON, TOML, YAML) use maps with keys that
20//! are strictly strings and values that can be any primitive or a sequence/map
21//! thereof.
22//!
23//! # Examples
24//!
25//! TODO
26//!
27//! # License
28//!
29//! Copyright (C) 2018 Project Tsukurou!
30//!
31//! This program is free software: you can redistribute it and/or modify
32//! it under the terms of the GNU General Public License as published by
33//! the Free Software Foundation, either version 3 of the License, or
34//! (at your option) any later version.
35//!
36//! This program is distributed in the hope that it will be useful,
37//! but WITHOUT ANY WARRANTY; without even the implied warranty of
38//! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
39//! GNU General Public License for more details.
40//!
41//! You should have received a copy of the GNU General Public License
42//! along with this program. If not, see <https://www.gnu.org/licenses/>.
43
44#![warn(missing_docs)]
45
46#[macro_use]
47extern crate serde;
48
49pub mod value;
50pub mod table;
51
52#[doc(inline)] pub use self::value::{Value, to_value, from_value};
53#[doc(inline)] pub use self::table::Table;