whichtime-sys 0.1.0

Lower-level parsing engine for natural language date parsing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# whichtime-sys

`whichtime-sys` is the lower-level Rust parsing engine that powers the higher-level [`whichtime`](https://docs.rs/whichtime) crate.

Use this crate when you want direct access to the engine itself, its locale-specific parser construction, or its lower-level types without the higher-level convenience wrapper.

## Installation

```toml
[dependencies]
whichtime-sys = "0.1"
```

## When To Use `whichtime-sys`

- You want direct control over the underlying parser engine.
- You are building custom parser/refiner pipelines.
- You want the lower-level crate that `whichtime` builds on top of.

If you just want the recommended Rust API for application code, use [`whichtime`](https://docs.rs/whichtime) instead.

## Example

```rust
use whichtime_sys::{Locale, WhichTime};

fn main() -> whichtime_sys::Result<()> {
    let parser = WhichTime::with_locale(Locale::En);

    if let Some(date) = parser.parse_date("next Friday at noon", None)? {
        println!("{}", date.to_rfc3339());
    }

    Ok(())
}
```

## Performance Notes

The engine uses a parser pipeline with fast token scanning, compile-time dictionaries, and compact component storage to keep parsing efficient. Benchmark and implementation details live in the repository guide.

## Development Commands

```bash
cargo test -p whichtime-sys
cargo bench -p whichtime-sys
```

## Documentation

- Guide: <https://transcodeworks.github.io/whichtime/>
- API docs: <https://docs.rs/whichtime-sys>
- Recommended high-level crate: <https://docs.rs/whichtime>