Skip to content

API Reference

This section provides detailed API documentation for whichtime.

Quick Reference

Main Types

TypeDescription
WhichTimeMain parser (Rust)
WhichTimeParserMain parser (FFI)
ParsedResultParsing result
FastComponentsDate/time components
LocaleSupported locales

Key Methods

MethodDescription
parse()Parse text, return all matches
parse_date()Parse text, return first date
parse_with_locale()Parse with specific locale

By Language

Rust

rust
use whichtime::{Locale, ParsedResult, WhichTime};

let parser = WhichTime::new();
let results: Vec<ParsedResult> = parser.parse("tomorrow", None)?;

See Rust API details.

Swift

swift
import WhichtimeCore

let parser = WhichTimeParser()
let results: [WhichTimeResult] = try parser.parse(text: "tomorrow", locale: .en)

See Swift API details.

Kotlin

kotlin
import works.transcode.whichtime.*

val parser = WhichTimeParser()
val results: List<WhichTimeResult> = parser.parse("tomorrow", WhichTimeLocale.EN)

See Kotlin API details.

Python

python
from whichtime import WhichTimeParser, WhichTimeLocale

parser = WhichTimeParser()
results: list[WhichTimeResult] = parser.parse("tomorrow", WhichTimeLocale.EN)

See Python API details.

Rust Docs

For complete Rust API documentation, see docs.rs/whichtime. If you need the lower-level engine crate, see docs.rs/whichtime-sys.

Released under the MIT License.