package timedesc

  1. Overview
  2. Docs
OCaml date time handling library

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (18)

Authors

  1. D
    Daypack developers

Maintainers

  1. D
    Darren Ldl <darrenldldev@gmail.com>

Sources

timedesc-1.1.0.tar.gz
sha256=2be785e3a8699748d79433b655a66412642dc380391a5643f8997e6c193bbfff

doc/timedesc/Timedesc/Span/For_human/index.html

Module Span.For_humanSource

Sourcetype sign = [
  1. | `Pos
  2. | `Neg
]
Sourcetype view = private {
  1. sign : sign;
  2. days : int;
  3. hours : int;
  4. minutes : int;
  5. seconds : int;
  6. ns : int;
}
Sourcetype error = [
  1. | `Invalid_days of int
  2. | `Invalid_hours of int
  3. | `Invalid_minutes of int
  4. | `Invalid_seconds of int
  5. | `Invalid_ns of int
]
Sourcetype error_f = [
  1. | `Invalid_days_f of float
  2. | `Invalid_hours_f of float
  3. | `Invalid_minutes_f of float
  4. | `Invalid_seconds_f of float
  5. | `Invalid_ns of int
]
Sourceexception Error_exn of error
Sourceexception Error_f_exn of error_f

Constructors

Sourceval make : ?sign:sign -> ?days:int -> ?hours:int -> ?minutes:int -> ?seconds:int -> ?ns:int -> unit -> (t, error) result

sign defaults to `Pos.

Returns Error if any of the arguments are negative.

  • raises Out_of_range

    if the value cannot be represented even after normalization

Sourceval make_exn : ?sign:sign -> ?days:int -> ?hours:int -> ?minutes:int -> ?seconds:int -> ?ns:int -> unit -> t
Sourceval make_frac : ?sign:sign -> ?days:float -> ?hours:float -> ?minutes:float -> ?seconds:float -> ?ns:int -> unit -> (t, error_f) result

sign defaults to `Pos.

Returns Error if any of the arguments are negative.

  • raises Out_of_range

    if the value cannot be represented even after normalization

Sourceval make_frac_exn : ?sign:sign -> ?days:float -> ?hours:float -> ?minutes:float -> ?seconds:float -> ?ns:int -> unit -> t

Viewer

Sourceval view : t -> view

Pretty printing

Sourceval pp : ?format:string -> unit -> Format.formatter -> t -> unit

Pretty printing for span. * * Default format string:

{days-nz: days }{hours-nz:X hours }{mins-nz:X mins }{secs:X}{sec-frac:.X} secs

Format string specification:

{{                      literal {
{days:unit}             number of days
                        unit is the string used after the number to denote its unit
{days-nz:unit}          same as above, but does not display if number is zero

{hours:cXunit}          number of hour, sub-day
                        character 'c' before 'X' is used for padding
                        (leave out character for no padding)
                        unit is the string used after the number to denote its unit
{hours-nz:cXunit}       same as above, but does not display if number is zero

{mins:cXunit}           number of minutes, sub-hour
                        character 'c' before 'X' is used for padding
                        (leave out character for no padding)
                        unit is the string used after the number to denote its unit
{mins-nz:cXunit}        same as above, but does not display if number is zero

{secs:cXunit}           number of seconds, sub-minute
                        character 'c' before 'X' is used for padding
                        (leave out character for no padding)
                        unit is the string used after the number to denote its unit
{secs-nz:cXunit}        same as above, but does not display if number is zero

{sec-frac:cNXunit}      fraction of second, sub-second
                        N determines the number of digits to take after decimal separator
                        if N is not specified, then the smallest number of digits required
                        after decimal separator for a lossless representation is used
                        character c is used as the decimal separator
                        unit is the string used after the number to denote its unit
{secs-frac-nz:cNXunit}  same as above, but does not display if nanosecond count is
                        zero

*

Sourceval to_string : ?format:string -> t -> string