Period_repr (mavryk-protocol-001-PtAtLas.Mavryk_raw_protocol_001_PtAtLas.Period

type t

type period = t

Represents a period of time as a non-negative integer.

include Mavryk_protocol_environment_001_PtAtLas.Compare.S with type t := t

val (=) : t -> t -> bool

val (<>) : t -> t -> bool

val (<) : t -> t -> bool

val (<=) : t -> t -> bool

val (>=) : t -> t -> bool

val (>) : t -> t -> bool

val equal : t -> t -> bool

val max : t -> t -> t

val min : t -> t -> t

val encoding : period Mavryk_protocol_environment_001_PtAtLas.Data_encoding.t

val rpc_arg : period Mavryk_protocol_environment_001_PtAtLas.RPC_arg.t

val pp : 
  Mavryk_protocol_environment_001_PtAtLas.Format.formatter ->
  period ->
  unit

val to_seconds : period -> int64

Returns the number of seconds contained in the period.

val of_seconds : 
  int64 ->
  period Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult

Converts a number of seconds to a period.

of_second s fails if s is not positive.

val of_seconds_exn : int64 -> period

Converts a number of seconds to period.

of_second s fails if s is not positive. It should only be used at toplevel for constants.

val add : 
  period ->
  period ->
  period Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult

Safe addition of periods, guarded against overflow.

val (+?) : 
  period ->
  period ->
  period Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult

Alias for add.

val mult : 
  int32 ->
  period ->
  period Mavryk_protocol_environment_001_PtAtLas.Error_monad.tzresult

Safe multiplication by a positive integer. Guarded against overflow.

val zero : period

val one_second : period

val one_minute : period

val one_hour : period

val compare : period -> period -> int

compare x y returns 0 if x is equal to y, a negative integer if x is shorter than y, and a positive integer if x is longer than y.