implement Range

Author: tomoikey

README.md

@@ -381,7 +381,7 @@ fn equal_example() -> Result<(), Error<u8>> {
 }
 ```
 
-## LessEqual
+## `LessEqual`
 
 `LessEqual` is a type that signifies the target is less than or equal to a certain number.
 
@@ -402,7 +402,7 @@ fn less_equal_example() -> Result<(), Error<u8>> {
 }
 ```
 
-## GreaterEqual
+## `GreaterEqual`
 
 `GreaterEqual` is a type that signifies the target is greater than or equal to a certain number.
 
@@ -423,6 +423,31 @@ fn greater_equal_example() -> Result<(), Error<u8>> {
 }
 ```
 
+## `Range`
+
+`Range` is a type that signifies the target exists between a certain number and another number.
+
+```rust
+type Age = RangeU8<18, 80>;
+
+fn range_example() -> Result<(), Error<u8>> {
+    let age = Age::new(17);
+    assert!(age.is_err());
+
+    let age = Age::new(18)?;
+    assert_eq!(age.into_value(), 18);
+
+    let age = Age::new(79)?;
+    assert_eq!(age.into_value(), 79);
+
+    let age = Age::new(80);
+    assert!(age.is_err());
+
+    Ok(())
+}
+```
+
+
 # Iterator
 
 `refined_type` has several useful refined types for Iterators.

tests/read_me.rs

@@ -3,12 +3,7 @@ use serde_json::json;
 
 use refined_type::result::Error;
 use refined_type::rule::composer::Not;
-use refined_type::rule::{
-    EqualU8, ExistsVec, ForAllVec, GreaterEqualU8, GreaterU8, HeadVec, IndexRuleVec, IndexVec,
-    InitVec, LastVec, LengthDefinition, LengthEqual, LengthEqualRule, LengthGreater, LengthLess,
-    LengthMinMax, LessEqualU8, LessU8, MinMaxU8, NonEmptyString, NonEmptyStringRule, NonEmptyVec,
-    NonEmptyVecDeque, Reverse, Rule, SkipFirst, SkipVec, TailVec,
-};
+use refined_type::rule::{EqualU8, ExistsVec, ForAllVec, GreaterEqualU8, GreaterU8, HeadVec, IndexRuleVec, IndexVec, InitVec, LastVec, LengthDefinition, LengthEqual, LengthEqualRule, LengthGreater, LengthLess, LengthMinMax, LessEqualU8, LessU8, MinMaxU8, NonEmptyString, NonEmptyStringRule, NonEmptyVec, NonEmptyVecDeque, RangeU8, Reverse, Rule, SkipFirst, SkipVec, TailVec};
 use refined_type::{And, Or, Refined};
 
 // define a struct for converting from JSON.
@@ -344,6 +339,25 @@ fn greater_equal_example() -> Result<(), Error<u8>> {
     Ok(())
 }
 
+#[test]
+fn range_example() -> Result<(), Error<u8>> {
+    type Age = RangeU8<18, 80>;
+
+    let age = Age::new(17);
+    assert!(age.is_err());
+
+    let age = Age::new(18)?;
+    assert_eq!(age.into_value(), 18);
+
+    let age = Age::new(79)?;
+    assert_eq!(age.into_value(), 79);
+
+    let age = Age::new(80);
+    assert!(age.is_err());
+
+    Ok(())
+}
+
 #[test]
 fn example_11() -> Result<(), Error<Vec<String>>> {
     let vec = vec!["Hello".to_string(), "World".to_string()];