https://github.com/westy92/timelib-rust

A small Rust wrapper around the timelib library.
https://github.com/westy92/timelib-rust

bindgen bindgen-wrapper ffi ffi-bindings ffi-wrapper mongodb php rust rust-crate rust-crates rust-ffi rust-ffi-bindings rust-ffi-wrappers rust-lang rust-library strtotime timelib timelib-library

Last synced: 11 days ago
JSON representation

A small Rust wrapper around the timelib library.

• Host: GitHub
• URL: https://github.com/westy92/timelib-rust
• Owner: westy92
• License: mit
• Created: 2023-05-06T17:35:33.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-16T04:50:33.000Z (2 months ago)
• Last Synced: 2024-11-02T01:42:22.368Z (18 days ago)
• Topics: bindgen, bindgen-wrapper, ffi, ffi-bindings, ffi-wrapper, mongodb, php, rust, rust-crate, rust-crates, rust-ffi, rust-ffi-bindings, rust-ffi-wrappers, rust-lang, rust-library, strtotime, timelib, timelib-library
• Language: C
• Homepage: https://crates.io/crates/timelib
• Size: 189 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Timelib for Rust

[![Crates.io](https://img.shields.io/crates/v/timelib)](https://crates.io/crates/timelib)

[![Build Status](https://github.com/westy92/timelib-rust/actions/workflows/ci.yml/badge.svg)](https://github.com/westy92/timelib-rust/actions/workflows/ci.yml)

[![docs.rs](https://img.shields.io/docsrs/timelib)](https://docs.rs/timelib)

[![Code Coverage](https://codecov.io/gh/westy92/timelib-rust/branch/main/graph/badge.svg)](https://codecov.io/gh/westy92/timelib-rust)

[![Funding Status](https://img.shields.io/github/sponsors/westy92)](https://github.com/sponsors/westy92)

Timelib for Rust is a small Rust wrapper around the [timelib](https://github.com/derickr/timelib) library that is used to power PHP and MongoDB.

## Installation

You can install with:

```bash

cargo add timelib

```

## Usage

```rust

let tz = timelib::Timezone::parse("America/Chicago").expect("Error parsing timezone!");

timelib::strtotime("tomorrow", None, &tz);

timelib::strtotime("next tuesday", Some(1654318823), &tz);

```

View the tests for more examples.

## Optional Features

The genereated `re2c` outputs are bundled and automatically used. If you wish to generate these files yourself, do the following:

1. Install `re2c`. You can install it easily on all major platforms:

    - Linux: `apt-get install re2c`

    - Mac: `brew install re2c`

    - Windows: `choco install re2c`

    - From source: [re2c.org](https://re2c.org/)

1. Enable the `re2c` feature:

    - `timelib = { version = "0.3", features = ["re2c"] }`

## Building

Make sure to check out all submodules.

Initial clone:

```bash

git clone --recurse-submodules https://github.com/westy92/timelib-rust

```

Post-clone:

```bash

git submodule init && git submodule update

```

You should now be able to run `cargo build` and `cargo test`.

If using the `re2c` feature, make sure to install `re2c` as described above. i.e. `cargo test --features re2c`.

## Updating the submodule version

```bash

git submodule update --remote

```

Make sure to regenerate the re2c outputs and copy them to `pregenerated/`.

```bash

cd ext/timelib/

make parse_date.c parse_iso_intervals.c

cp parse_date.c ../../pregenerated/

cp parse_iso_intervals.c ../../pregenerated/

```

## Publishing

Remove `--dry-run` to publish for real.

```bash

cargo publish --dry-run

```