Source file pgx_value_intf.ml

(** A wrapper for holding Postgres types *)
module type S = sig

  type t = string option [@@deriving sexp_of]

  exception Conversion_failure of string [@@deriving sexp]

  val required : ('a -> 'b) -> 'a option -> 'b

  val opt : ('a -> t) -> 'a option -> t

  val null : t

  val of_bool : bool -> t
  val to_bool_exn : t -> bool
  val to_bool : t -> bool option

  val of_float : float -> t
  val to_float_exn : t -> float
  val to_float : t -> float option

  type hstore = (string * string option) list [@@deriving sexp]
  val of_hstore : hstore -> t
  val to_hstore_exn : t -> hstore
  val to_hstore : t -> hstore option

  type inet = Unix.inet_addr * int [@@deriving sexp_of]
  val of_inet : inet -> t
  val to_inet_exn : t -> inet
  val to_inet : t -> inet option

  val of_int : int -> t
  val to_int_exn : t -> int
  val to_int : t -> int option

  val of_int32 : int32 -> t
  val to_int32_exn : t -> int32
  val to_int32 : t -> int32 option

  val of_int64 : int64 -> t
  val to_int64_exn : t -> int64
  val to_int64 : t -> int64 option

  val of_list : t list -> t
  val to_list_exn : t -> t list
  val to_list : t -> t list option

  type point = float * float [@@deriving sexp]
  val of_point : point -> t
  val to_point_exn : t -> point
  val to_point : t -> point option

  val of_string : string -> t
  val to_string_exn : t -> string
  val to_string : t -> string option

  val unit : t
  val to_unit_exn : t -> unit
  val to_unit : t -> unit option

  type uuid = Uuidm.t [@@deriving sexp_of]
  val of_uuid : uuid -> t
  val to_uuid_exn : t -> uuid
  val to_uuid : t -> uuid option
end