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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
// License: see LICENSE file at root directory of `master` branch //! # Dia-range //! //! _Ranges for all integers_ //! //! ## Project //! //! - Repository: <https://bitbucket.org/haibison/dia-range> //! - License: [Free Public License 1.0.0](https://opensource.org/licenses/FPL-1.0.0) //! - _This project follows [Semantic Versioning 2.0.0]_ //! //! ## Features //! //! - `RangeType` and `Ops` traits are implemented for all integer primitive types. So you can use [`Range`][crate::Range] on them. //! - Currently only [`Range`][crate::Range] is recommended for use. Both `RangeType` and `Ops` traits are intended for internal use only. //! However they have to be available publicly for `Range` to be valid. So their APIs look weird. It's _not_ recommended to build things from //! them. //! //! ## Examples //! //! ``` //! use dia_range::Range; //! //! // First type i16 is for indexes; second type (u16) is for estimating range size. //! // You can ignore second type, the compiler will figure it out. //! let mut range: Range<i16, _> = Range::new(50, 100); //! assert!(range.contains(&99)); //! assert!(range.expand(101)); //! assert!(range.expand(103) == false); //! assert!(range.contains(&101)); //! assert_eq!(range.estimate_size(), 52); //! //! // Merging //! assert_eq!(range.merge(&Range::new(100, 150)), Some(Range::new(50, 150))); //! ``` //! //! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html //! [crate::Range]: struct.Range.html #![warn(missing_docs)] mod range; mod range_iter; pub use range::*; pub use range_iter::*; // ╔═════════════════╗ // ║ IDENTIFIERS ║ // ╚═════════════════╝ macro_rules! code_name { () => { "dia-range" }} macro_rules! version { () => { "0.3.0" }} /// # Crate name pub const NAME: &'static str = "Dia-range"; /// # Crate code name pub const CODE_NAME: &'static str = code_name!(); /// # Crate version pub const VERSION: &'static str = version!(); /// # Crate release date (year/month/day) pub const RELEASE_DATE: (u16, u8, u8) = (2019, 2, 28); /// # Unique universally identifier of this crate pub const UUID: &'static str = "bdd0fdae-f550-41f1-8952-280df73f4b06"; /// # Tag, which can be used for logging... pub const TAG: &'static str = concat!(code_name!(), "::bdd0fdae::", version!()); // ╔════════════════════╗ // ║ IMPLEMENTATION ║ // ╚════════════════════╝ #[test] fn test_crate_version() { assert_eq!(VERSION, env!("CARGO_PKG_VERSION")); }