Compare commits

...

3 Commits

Author SHA1 Message Date
Dmitriy Pleshevskiy 8814c6ef14
chore: cleanup unused imports 2022-07-28 14:42:51 +03:00
Dmitriy Pleshevskiy 81202b9d57
bump version 2022-07-28 14:37:00 +03:00
Dmitriy Pleshevskiy 039a0dd630
doc: add examples to readme 2022-07-28 14:36:09 +03:00
10 changed files with 97 additions and 17 deletions

2
Cargo.lock generated
View File

@ -4,4 +4,4 @@ version = 3
[[package]]
name = "estring"
version = "0.2.1"
version = "0.3.0"

View File

@ -1,7 +1,7 @@
[package]
name = "estring"
description = "A simple way to parse a string using type annotations"
version = "0.2.1"
version = "0.3.0"
edition = "2021"
authors = ["Dmitriy Pleshevskiy <dmitriy@ideascup.me>"]
readme = "README.md"

View File

@ -7,7 +7,7 @@
```toml
[dependencies]
estring = "0.2"
estring = "0.3"
```
A simple way to parse a string using type annotations.
@ -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

View File

@ -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;

View File

@ -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)]

View File

@ -1,4 +1,4 @@
use crate::core::{Aggregatable, EString, ParseFragment, ToEString};
use crate::core::{EString, ParseFragment, ToEString};
use crate::error::{Error, Reason};
impl ParseFragment for bool {
@ -19,7 +19,8 @@ impl ToEString for bool {
}
}
impl Aggregatable for bool {
#[cfg(feature = "aggs")]
impl crate::core::Aggregatable for bool {
type Item = Self;
#[inline]

View File

@ -1,4 +1,4 @@
use crate::core::{Aggregatable, EString, ParseFragment, ToEString};
use crate::core::{EString, ParseFragment, ToEString};
use crate::error::{Error, Reason};
#[doc(hidden)]
@ -19,7 +19,8 @@ macro_rules! from_env_string_numbers_impl {
}
}
impl Aggregatable for $ty {
#[cfg(feature = "aggs")]
impl crate::core::Aggregatable for $ty {
type Item = Self;
#[inline]

View File

@ -1,4 +1,4 @@
use crate::core::{Aggregatable, EString, ParseFragment, ToEString};
use crate::core::{EString, ParseFragment, ToEString};
impl<T> ToEString for Option<T>
where
@ -25,9 +25,10 @@ where
}
}
impl<T> Aggregatable for Option<T>
#[cfg(feature = "aggs")]
impl<T> crate::core::Aggregatable for Option<T>
where
T: Aggregatable,
T: crate::core::Aggregatable,
{
type Item = T::Item;

View File

@ -118,7 +118,7 @@ hello=bar",
#[test]
fn should_format_pair() {
let pair = Pair::<_, '+', _>(1, 2);
assert_eq!(pair.clone().to_estring(), EString(String::from("1+2")));
assert_eq!(pair.to_estring(), EString(String::from("1+2")));
let pair_in_pair = Pair::<_, '=', _>(3, pair);
assert_eq!(pair_in_pair.to_estring(), EString(String::from("3=1+2")));
}

View File

@ -1,7 +1,7 @@
//! Contains the implementations to vec type
//!
use crate::core::{Aggregatable, EString, ParseFragment, ToEString};
use crate::core::{EString, ParseFragment, ToEString};
use std::fmt::Write;
/// Wrapper for ``Vec`` to split string by a separator (`SEP`).
@ -92,9 +92,10 @@ where
}
}
impl<T, const SEP: char> Aggregatable for SepVec<T, SEP>
#[cfg(feature = "aggs")]
impl<T, const SEP: char> crate::core::Aggregatable for SepVec<T, SEP>
where
T: Aggregatable,
T: crate::core::Aggregatable,
{
type Item = T::Item;
@ -106,6 +107,7 @@ where
#[cfg(test)]
mod tests {
use super::*;
use crate::Aggregatable;
use crate::Pair;
use crate::{Error, Reason};