opening-hours

Crates.ioopening-hours
lib.rsopening-hours
version0.9.1
sourcesrc
created_at2021-02-08 17:49:59.348619
updated_at2024-11-26 13:06:00.424536
descriptionA parser and evaluation tool for the opening_hours fields in OpenStreetMap.
homepagehttps://github.com/remi-dupre/opening-hours-rs
repositoryhttps://github.com/remi-dupre/opening-hours-rs
max_upload_size
id352415
size1,888,254
Rémi Dupré (remi-dupre)

documentation

https://docs.rs/opening-hours

README

🦀 Rust implementation for OSM Opening Hours

🐍 Python bindings can be found here

A Rust library for parsing and working with OSM's opening hours field. You can find its specification here and the reference JS library here.

Note that the specification is quite messy and that the JS library takes liberty to extend it quite a lot. This means that most of the real world data don't actually comply to the very restrictive grammar detailed in the official specification. This library tries to fit with the real world data while remaining as close as possible to the core specification.

Usage

Add this to your Cargo.toml:

[dependencies]
opening-hours = "0"

Here's a simple example that parse an opening hours description and displays its current status and date for next change:

use chrono::Local;
use opening_hours::OpeningHours;

// Opens until 18pm during the week and until 12am the week-end.
const OH: &str = "Mo-Fr 10:00-18:00; Sa-Su 10:00-12:00";

fn main() {
    let oh: OpeningHours = OH.parse().unwrap();
    let date = Local::now().naive_local();
    println!("Current status is {:?}", oh.state(date));
    println!("This will change at {:?}", oh.next_change(date).unwrap());
}

Supported features

Holidays

A public holiday database is loaded using nager. You can refer to their website for more detail on supported country or if you want to contribute.

Syntax

If you are only interested in parsing expressions but not on the evaluation or if you want to build your own evaluation engine, you should probably rely on the opening-hours-syntax crate.

Commit count: 228

cargo fmt