Crate time

Feature flags

This crate exposes a number of features. These can be enabled or disabled as shown in Cargo’s documentation. Features are disabled by default unless otherwise noted.

Reliance on a given feature is always indicated alongside the item definition.

• std (enabled by default, implicitly enables alloc)

  This enables a number of features that depend on the standard library.

• alloc (enabled by default via std)

  Enables a number of features that require the ability to dynamically allocate memory.

• macros

  Enables macros that provide compile-time verification of values and intuitive syntax.

• formatting (implicitly enables std)

  Enables formatting of most structs.

• parsing

  Enables parsing of most structs.

• local-offset (implicitly enables std)

  This feature enables a number of methods that allow obtaining the system’s UTC offset.

• large-dates

  By default, only years within the ±9999 range (inclusive) are supported. If you need support for years outside this range, consider enabling this feature; the supported range will be increased to ±999,999.

  Note that enabling this feature has some costs, as it means forgoing some optimizations. Ambiguities may be introduced when parsing that would not otherwise exist.

• serde

  Enables serde support for all types.

• serde-human-readable (implicitly enables serde, formatting, and parsing)

  Allows serde representations to use a human-readable format. This is determined by the serializer, not the user. If this feature is not enabled or if the serializer requests a non-human-readable format, a format optimized for binary representation will be used.

  Libraries should never enable this feature, as the decision of what format to use should be up to the user.

• rand

  Enables rand support for all types.

• quickcheck (implicitly enables alloc)

  Enables quickcheck support for all types.

• wasm-bindgen

  Enables wasm-bindgen support for converting JavaScript dates, as well as obtaining the UTC offset from JavaScript.

Re-exports

pub use crate::error::Error;

Modules

convert

Conversion between units of time.

error

Various error types returned by methods in the time crate.

ext

Extension traits.

format_descriptionformatting or parsing

Description of how types should be formatted and parsed.

formattingformatting

Formatting for various types.

macrosmacros

Macros to construct statically known values.

parsingparsing

Parsing for various types.

serdeserde

Differential formats for serde.

util

Utility functions, including updating time zone information.

Structs

Date

Date in the proleptic Gregorian calendar.

Duration

A span of time with nanosecond precision.

OffsetDateTime

A PrimitiveDateTime with a UtcOffset.

PrimitiveDateTime

Combined date and time.

Time

The clock time within a given date. Nanosecond precision.

UtcDateTime

A PrimitiveDateTime that is known to be UTC.

UtcOffset

An offset from UTC.

Enums

Month

Months of the year.

Weekday

Days of the week.

Type Aliases

Result

An alias for std::result::Result with a generic error from the time crate.