Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 3.5 KB

README.md

File metadata and controls

84 lines (67 loc) · 3.5 KB
Raw

strftime-ruby

GitHub Actions Code Coverage Discord Twitter
Crate API API trunk

strftime-ruby is a Ruby 3.1.2 compatible implementation of the Time#strftime method. The strftime routines provided by this crate are POSIX-compatible, except for intentionally ignoring the E and O modified conversion specifiers.

Formats time according to the directives in the given format string.

The directives begin with a percent (%) character. Any text not listed as a directive will be passed through to the output string.

The directive consists of a percent (%) character, zero or more flags, optional minimum field width, optional modifier and a conversion specifier as follows:

%<flags><width><modifier><conversion>

Usage

Add this to your Cargo.toml:

[dependencies]
strftime-ruby = "1.0.1"

Crate features

All features are enabled by default.

  • std - Enables a dependency on the Rust Standard Library. Activating this feature enables implementations of std::error::Error on the error types in this crate and the strftime::io module, which depends on std::io::Write. Activating this feature also activates the alloc feature.
  • alloc - Enables a dependency on the Rust alloc crate. Activating this feature enables the strftime::bytes and stftime::string modules, which depend on alloc::vec::Vec and alloc::string::String. When the alloc feature is enabled, this crate only uses fallible allocation APIs.

Minimum Supported Rust Version

This crate requires at least Rust 1.58.0. This version can be bumped in minor releases.

License

strftime-ruby is licensed under the MIT License (c) Ryan Lopopolo and x-hgg-x.

This repository includes a vendored copy of strftime.c from Ruby 3.1.2, which is licensed under the Ruby license or BSD 2-clause license. See vendor/README.md for more details. These sources are not distributed on crates.io.