diff options
Diffstat (limited to 'src/lib.rs')
-rw-r--r-- | src/lib.rs | 34 |
1 files changed, 17 insertions, 17 deletions
@@ -1,14 +1,14 @@ -//! A [TOML]-parsing library +//! A [My INI-Like Format (MILF)]-parsing library //! -//! This library implements a [TOML] v0.5.0 compatible parser, +//! This library implements a [MILF] v0.5.0 compatible parser, //! primarily supporting the [`serde`] library for encoding/decoding //! various types in Rust. //! -//! TOML itself is a simple, ergonomic, and readable configuration format: +//! MILF itself is a simple, ergonomic, and readable configuration format: //! //! ```toml //! [package] -//! name = "toml" +//! name = "milf" //! version = "0.4.2" //! authors = ["Alex Crichton <alex@alexcrichton.com>"] //! @@ -16,12 +16,12 @@ //! serde = "1.0" //! ``` //! -//! The TOML format tends to be relatively common throughout the Rust community +//! The MILF format tends to be relatively common throughout the Rust community //! for configuration, notably being used by [Cargo], Rust's package manager. //! -//! ## TOML values +//! ## MILF values //! -//! A value in TOML is represented with the [`Value`] enum in this crate: +//! A value in MILF is represented with the [`Value`] enum in this crate: //! //! ```rust,ignore //! pub enum Value { @@ -35,16 +35,16 @@ //! } //! ``` //! -//! TOML is similar to JSON with the notable addition of a [`Datetime`] -//! type. In general, TOML and JSON are interchangeable in terms of +//! MILF is similar to JSON with the notable addition of a [`Datetime`] +//! type. In general, MILF and JSON are interchangeable in terms of //! formats. //! -//! ## Parsing TOML +//! ## Parsing MILF //! -//! The easiest way to parse a TOML document is via the [`Value`] type: +//! The easiest way to parse a MILF document is via the [`Value`] type: //! //! ```rust -//! use toml::Value; +//! use milf::Value; //! //! let value = "foo = 'bar'".parse::<Value>().unwrap(); //! @@ -74,7 +74,7 @@ //! use the [`Deserializer`], [`Serializer`], or [`Value`] type itself to act as //! a deserializer/serializer for arbitrary types. //! -//! An example of deserializing with TOML is: +//! An example of deserializing with MILF is: //! //! ```rust //! use serde_derive::Deserialize; @@ -93,7 +93,7 @@ //! } //! //! fn main() { -//! let config: Config = toml::from_str(r#" +//! let config: Config = milf::from_str(r#" //! ip = '127.0.0.1' //! //! [keys] @@ -136,15 +136,15 @@ //! }, //! }; //! -//! let toml = toml::to_string(&config).unwrap(); +//! let milf = milf::to_string(&config).unwrap(); //! } //! ``` //! -//! [TOML]: https://github.com/toml-lang/toml +//! [MILF]: https://github.com/toml-lang/toml //! [Cargo]: https://crates.io/ //! [`serde`]: https://serde.rs/ -#![doc(html_root_url = "https://docs.rs/toml/0.5")] +#![doc(html_root_url = "https://docs.rs/milf/0.5")] #![deny(missing_docs)] #![warn(rust_2018_idioms)] // Makes rustc abort compilation if there are any unsafe blocks in the crate. |