doc: add examples to readme

README.md

@@ -24,6 +24,23 @@ For more details, see [examples].
 
 ## Usage
 
+Basic
+
+```rust
+use estring::EString;
+
+fn main() -> estring::Result<()> {
+    let res: i32 = EString::from("10").parse()?;
+    assert_eq!(res, 10);
+    Ok(())
+}
+```
+
+You can use predefined structs like `SepVec` if you enable the `structs`
+feature.
+
+Note: You can use custom types as annotations! Just implement `ParseFragment`!
+
 ```rust
 use estring::{SepVec, EString};
 
@@ -42,8 +59,23 @@ fn main() -> estring::Result<()> {
 }
 ```
 
-You can use custom types as annotations! Just implement
-`estring::ParseFragment`!
+You can also use predefined aggregators if you enable the `aggs` feature.
+
+```rust
+use estring::{Aggregate, EString, Product, SepVec, Sum};
+
+type PlusVec<T> = SepVec<T, '+'>;
+type MulVec<T> = SepVec<T, '*'>;
+
+fn main() -> estring::Result<()> {
+    let res = EString::from("10+5*2+3")
+        .parse::<Sum<PlusVec<Product<MulVec<f32>>>>>()?
+        .agg();
+
+    assert_eq!(res, 23.0);
+    Ok(())
+}
+```
 
 ## Contact Us
 

src/core.rs

@@ -240,6 +240,7 @@ impl ParseFragment for EString {
     }
 }
 
+#[cfg(feature = "aggs")]
 impl Aggregatable for EString {
     type Item = Self;
 
@@ -263,6 +264,7 @@ impl ToEString for String {
     }
 }
 
+#[cfg(feature = "aggs")]
 impl Aggregatable for String {
     type Item = Self;
 
@@ -286,6 +288,7 @@ impl<'a> ToEString for &'a str {
     }
 }
 
+#[cfg(feature = "aggs")]
 impl<'a> Aggregatable for &'a str {
     type Item = Self;
 

src/lib.rs

@@ -7,7 +7,23 @@
 //!
 //! [enve]: https://github.com/pleshevskiy/enve
 //!
-//! ## Getting started
+//! ## Usage
+//!
+//! Basic
+//!
+//! ```rust
+//! use estring::EString;
+//!
+//! fn main() -> estring::Result<()> {
+//!     let res: i32 = EString::from("10").parse()?;
+//!     assert_eq!(res, 10);
+//!     Ok(())
+//! }
+//! ```
+//!
+//! You can use predefined structs like ``SepVec`` if you enable `structs` feature.
+//!
+//! Note: You can use custom types as annotations! Just implement ``ParseFragment``!
 //!
 //! ```rust
 //! use estring::{SepVec, EString};
@@ -27,6 +43,30 @@
 //! }
 //! ```
 //!
+//! You can also use predefined aggregators if you enable `aggs` feature.
+//!
+//! ```rust
+//! use estring::{Aggregate, EString, Product, SepVec, Sum};
+//!
+//! type PlusVec<T> = SepVec<T, '+'>;
+//! type MulVec<T> = SepVec<T, '*'>;
+//!
+//! fn main() -> estring::Result<()> {
+//!     let res = EString::from("10+5*2+3")
+//!         .parse::<Sum<PlusVec<Product<MulVec<f32>>>>>()?
+//!         .agg();
+//!
+//!     assert_eq!(res, 23.0);
+//!     Ok(())
+//! }
+//! ```
+//!
+//! ---
+//!
+//! For more details, see [examples].
+//!
+//! [examples]: https://github.com/pleshevskiy/estring/tree/main/examples
+//!
 #![deny(clippy::pedantic)]
 #![allow(clippy::module_name_repetitions)]
 #![warn(missing_docs)]

src/std/bool.rs

@@ -19,6 +19,7 @@ impl ToEString for bool {
     }
 }
 
+#[cfg(feature = "aggs")]
 impl Aggregatable for bool {
     type Item = Self;
 

src/std/number.rs

@@ -19,6 +19,7 @@ macro_rules! from_env_string_numbers_impl {
                 }
             }
 
+            #[cfg(feature = "aggs")]
             impl Aggregatable for $ty {
                 type Item = Self;
 

src/std/option.rs

@@ -25,6 +25,7 @@ where
     }
 }
 
+#[cfg(feature = "aggs")]
 impl<T> Aggregatable for Option<T>
 where
     T: Aggregatable,

src/structs/sep_vec.rs

@@ -92,6 +92,7 @@ where
     }
 }
 
+#[cfg(feature = "aggs")]
 impl<T, const SEP: char> Aggregatable for SepVec<T, SEP>
 where
     T: Aggregatable,