ocf 0.6.0 · OCaml Package

type path = string list

module SMap : sig ... end

type error =

| Json_error of string
| Invalid_value of Yojson.Safe.t
| Invalid_path of path
| Path_conflict of path
| Error_at_path of path * error
| Exn_at_path of path * exn

exception Error of error

val string_of_error : error -> string

val json_error : string -> 'a

val invalid_value : Yojson.Safe.t -> 'a

val invalid_path : path -> 'a

val path_conflict : path -> 'a

val error_at_path : path -> error -> 'a

val exn_at_path : path -> exn -> 'a

module Wrapper : sig ... end

type !'a wrapper = 'a Wrapper.t

type 'a conf_option

val option : 
  ?doc:string ->
  ?cb:('a -> unit) ->
  'a wrapper ->
  'a ->
  'a conf_option

val get : 'a conf_option -> 'a

val set : 'a conf_option -> 'a -> unit

type 'a group

val group : [ `Open ] group

val add : [ `Open ] group -> path -> 'a conf_option -> [ `Open ] group

val add_group : [ `Open ] group -> path -> 'a group -> [ `Open ] group

val as_group : 'a conf_option -> [ `Closed ] group

val int : ?doc:string -> ?cb:(int -> unit) -> int -> int conf_option

val float : ?doc:string -> ?cb:(float -> unit) -> float -> float conf_option

val bool : ?doc:string -> ?cb:(bool -> unit) -> bool -> bool conf_option

val string : 
  ?doc:string ->
  ?cb:(string -> unit) ->
  string ->
  string conf_option

val list : 
  ?doc:string ->
  ?cb:('a list -> unit) ->
  'a wrapper ->
  'a list ->
  'a list conf_option

val option_ : 
  ?doc:string ->
  ?cb:('a option -> unit) ->
  'a wrapper ->
  'a option ->
  'a option conf_option

val pair : 
  ?doc:string ->
  ?cb:(('a * 'b) -> unit) ->
  'a wrapper ->
  'b wrapper ->
  ('a * 'b) ->
  ('a * 'b) conf_option

val triple : 
  ?doc:string ->
  ?cb:(('a * 'b * 'c) -> unit) ->
  'a wrapper ->
  'b wrapper ->
  'c wrapper ->
  ('a * 'b * 'c) ->
  ('a * 'b * 'c) conf_option

val string_map : 
  ?doc:string ->
  ?cb:('map -> unit) ->
  fold:
    ((string -> 'a -> Wrapper.assocs -> Wrapper.assocs) ->
      'map ->
      Wrapper.assocs ->
      Wrapper.assocs) ->
  add:(string -> 'a -> 'map -> 'map) ->
  empty:'map ->
  'a wrapper ->
  'map ->
  'map conf_option

val from_json : 'a group -> Yojson.Safe.t -> unit

val from_string : 'a group -> string -> unit

val from_file : 'a group -> string -> unit

val to_json : ?with_doc:bool -> 'a group -> Yojson.Safe.t

val to_string : ?with_doc:bool -> 'a group -> string

val to_file : ?with_doc:bool -> 'a group -> string -> unit

val to_arg : 
  'a conf_option ->
  ?doc:Arg.doc ->
  Arg.key ->
  Arg.key * Arg.spec * Arg.doc

package ocf