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
59
60
61
62
63
64
65
66

//! This crate provides simple types to parse and operate on a
//! Nagios range as described in the [Nagios Development Guidelines](https://nagios-plugins.org/doc/guidelines.html#THRESHOLDFORMAT).
//!
//! # Examples
//!
//! Create a `NagiosRange` from a literal string.
//! ```rust
//! use nagios_range::{NagiosRange, Error};
//!
//! fn main() -> Result<(), Error> {
//!     let range = NagiosRange::from("@0:10");
//!     assert!(range.is_ok());
//!
//!     Ok(())
//! }
//! ```
//!
//! Check if a `NagiosRange` codes for an inclusive or exclusive
//! range.
//! ```rust
//! use nagios_range::{NagiosRange, Error};
//!
//! fn main() -> Result<(), Error> {
//!     let range = NagiosRange::from("@0:10")?;
//!     assert!(range.is_inside());
//!     assert!(!range.is_outside());
//!
//!     Ok(())
//! }
//! ```
//!
//! Check if the start point of a `NagiosRange` (the lower bound)
//! matches negative infinity.
//! ```rust
//! use nagios_range::{NagiosRange, Error};
//!
//! fn main() -> Result<(), Error> {
//!     let range = NagiosRange::from("@~:10")?;
//!     assert!(range.start().is_neg_inf());
//!
//!     Ok(())
//! }
//! ```
//!
//! Extract the inner value of an end point.
//! ```rust
//! use nagios_range::{NagiosRange, Error};
//!
//! fn main() -> Result<(), Error> {
//!     let range = NagiosRange::from("@~:10")?;
//!     assert_eq!(range.end().inner(), Some(10));
//!
//!     Ok(())
//! }
//! ```
//!
//! # Planned future enhancements
//!
//! * The most important function when working with ranges
//! => `NagiosRange.contains()`.
pub mod error;
pub mod types;
pub use self::error::Error;
pub use self::types::End;
pub use self::types::NagiosRange;
pub use self::types::Start;