estring/README.md

1.2 KiB
Raw Blame History

EString

A simple way to parse a string using type annotations.

This package was originally designed for enve

Getting started

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:

[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 to see the full text.

Contributors

pleshevskiy (Dmitriy Pleshevskiy) creator, maintainer.