package timedesc

You can search for identifiers within the package.

in-package search v0.2.0

timedesc
- Timedesc
  - Date
    
    ISO_ord
    
    ISO_week_date
    
    Ymd
  - ISO_ord_date_time
  - ISO_week
  - ISO_week_date_time
  - Interval
  - Span
    
    For_human
  - Time
  - Time_zone
    
    Compressed
    
    Db
    
    Compressed
    
    Raw
  - Time_zone_info
  - Timestamp
  - Utils
  - Ym
  - Zoneless

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

A possibly valid pairing of time zone and offset. Whether the pairing actually makes sense still depends on the attached date time (or similar data).

type error = [

| `Missing_both_tz_and_offset_from_utc
| `Invalid_offset of Span.t
| `Unrecorded_offset of Span.t

]

val make : 
  ?tz:Time_zone.t ->
  ?offset_from_utc:Span.t ->
  unit ->
  (t, error) Stdlib.result

tz is the time zone tied. If only an offset is provided during construction, then a fixed offset time zone is constructed, e.g. if say only an offset of 10 hours is provided, tz becomes "UTC+10".

offset_from_utc is the fixed offset from UTC. If an offset is not provided but the time zone can be represented by a fixed offset, then said offset is used, e.g. "UTC+1" can be represented by fixed offset of 1 hour.

val make_exn : ?tz:Time_zone.t -> ?offset_from_utc:Span.t -> unit -> t

val tz : t -> Time_zone.t

val offset_from_utc : t -> Span.t option

val equal : t -> t -> bool