65 lines
2 KiB
Markdown
65 lines
2 KiB
Markdown
# EString
|
||
|
||
[](https://github.com/pleshevskiy/estring/actions/workflows/ci.yml)
|
||
[](https://docs.rs/estring)
|
||
[](https://crates.io/crates/estring)
|
||
[](https://github.com/pleshevskiy/estring/LICENSE)
|
||
[](https://github.com/rust-secure-code/safety-dance/)
|
||
[](https://matrix.to/#/!yZalHbWfGRWOMaetSn:matrix.org?via=matrix.org)
|
||
|
||
A simple way to parse a string using type annotations.
|
||
|
||
This package was originally designed for [enve]
|
||
|
||
[enve]: https://github.com/pleshevskiy/enve
|
||
|
||
## Getting started
|
||
|
||
```rust
|
||
use estring::{SepVec, EString};
|
||
|
||
type PlusVec<T> = SepVec<T, '+'>;
|
||
type MulVec<T> = SepVec<T, '*'>;
|
||
|
||
fn main() -> Result<(), estring::ParseError> {
|
||
let res = EString::from("10+5*2+3")
|
||
.parse::<PlusVec<MulVec<f32>>>()?
|
||
.iter()
|
||
.map(|m| m.iter().product::<f32>())
|
||
.sum::<f32>();
|
||
|
||
assert_eq!(res, 23.0);
|
||
Ok(())
|
||
}
|
||
```
|
||
|
||
You can use custom types as annotations! Just implement `TryFrom<EString>`!
|
||
|
||
## Installation
|
||
|
||
**The MSRV is 1.51.0**
|
||
|
||
Add `estring = { version = "0.1", features = ["vec", "number"] }` as a
|
||
dependency in `Cargo.toml`.
|
||
|
||
`Cargo.toml` example:
|
||
|
||
```toml
|
||
[package]
|
||
name = "my-crate"
|
||
version = "0.1.0"
|
||
authors = ["Me <user@rust-lang.org>"]
|
||
|
||
[dependencies]
|
||
estring = { version = "0.1", features = ["vec", "number"] }
|
||
```
|
||
|
||
## License
|
||
|
||
**MIT**. See [LICENSE](https://github.com/pleshevskiy/estring/LICENSE) to see
|
||
the full text.
|
||
|
||
## Contributors
|
||
|
||
[pleshevskiy](https://github.com/pleshevskiy) (Dmitriy Pleshevskiy) – creator,
|
||
maintainer.
|