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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! # Humanize
//!
//! Make your user interface more human friendly!
//!
//! This library provides functionality for both formatting values
//! into human friendly forms as well as parsing human input to get
//! back likely values.
//!
//! _Actually, the formatting isn't implemented yet. Contributions
//! are welcome!_
//!
//! This library is inspired by many other things, including:
//!
//! * Python's [humanize library].
//! * JavaScript's [moment.js].
//! * The ['at' command]'s input parsing.
//!
//! Contributions extending our functionality are welcome, as are
//! contributions that add support for additional languages.
//!
//! # Human-friendly Parsing
//!
//! When dealing with humans, you often want them to be able to
//! input values in a flexible manner. For example, you might want
//! to be able to input a `bool` using text like `"on"`, `"off"`,
//! `"yes"`, `"no"` or perhaps even `"nope"`.
//!
//! ```
//! let enabled = humanize::parse::<bool>("on").unwrap_or(false);
//! assert_eq!(enabled, true);
//! ```
//!
//! # Ideas for the Future
//!
//! * Actually implement formatting.
//!
//! [humanize library]: https://pypi.python.org/pypi/humanize
//! [moment.js]: http://momentjs.com/
//! ['at' command]: http://www.computerhope.com/unix/uat.htm

#![warn(missing_docs)]
#![deny(trivial_numeric_casts,
        unsafe_code, unstable_features,
        unused_import_braces, unused_qualifications)]

#[macro_use]
extern crate language_tags;

pub mod boolean;
mod parser;

pub use parser::{parse, parse_with_language, Parse};