Module `Eliom_parameter_base`Source

Sourceval section : Lwt_log_core.section

Sourcetype params = (string * Eliommod_parameters.param) list

Sourcetype params' = (string * string) list

Sourcetype +'a param_name = string

Type of names in a form

Sourcetype no_param_name

empty type used when it is not possible to use the parameter in a form

Sourcetype ('a, 'b) binsum =

| Inj1 of 'a
| Inj2 of 'b

Sourcetype 'an listnames = {

it : 'el 'a. ('an -> 'el -> 'a -> 'a) -> 'el list -> 'a -> 'a;

}

Sourcetype coordinates = {

abscissa : int;
ordinate : int;

}

Sourcetype 'a setoneradio = [

| `Set of 'a
| `One of 'a
| `Radio of 'a

]

Sourcetype 'a oneradio = [

| `One of 'a
| `Radio of 'a

]

Sourcetype 'a setone = [

| `Set of 'a
| `One of 'a

]

Sourcetype 'a to_and_of = {

of_string : string -> 'a;
to_string : 'a -> string;

}

Sourcetype _ atom =

| TFloat : float atom
| TInt : int atom
| TInt32 : int32 atom
| TInt64 : int64 atom
| TNativeint : nativeint atom
| TBool : bool atom
| TString : string atom

Sourceval string_of_atom : 'a atom -> 'a -> string

Sourceval atom_of_string : 'a atom -> string -> 'a

Sourceval to_from_of_atom : 'a atom -> 'a to_and_of

Sourcetype 'a filter = ('a -> unit) option

Source

type raw =
  ((string * string) * (string * string) list) option * Cohttp_lwt.Body.t

Sourcetype 'a ocaml = string

Sourcetype suff = [

| `WithoutSuffix
| `WithSuffix
| `Endsuffix

]

Sourcetype (_, _) params_type_ =

| TProd : (('a, 'an) params_type_ * ('b, 'bn) params_type_) -> ('a * 'b, 'an * 'bn) params_type_
| TOption : (('a, 'an) params_type_ * bool) -> ('a option, 'an) params_type_
| TList : (string * ('a, 'an) params_type_) -> ('a list, 'an listnames) params_type_
| TSet : ('a, [ `One of 'an ] param_name) params_type_ -> ('a list, [ `Set of 'an ] param_name) params_type_
| TSum : (('a, 'an) params_type_ * ('b, 'bn) params_type_) -> (('a, 'b) binsum, 'an * 'bn) params_type_
| TAtom : (string * 'a atom) -> ('a, [ `One of 'a ] param_name) params_type_
| TCoord : string -> (coordinates, [ `One of coordinates ] param_name) params_type_
| TFile : string -> (Eliom_lib.file_info, [ `One of Eliom_lib.file_info ] param_name) params_type_
| TUserType : (string * 'a Eliom_common.To_and_of_shared.t) -> ('a, [ `One of 'a ] param_name) params_type_
| TTypeFilter : (('a, 'an) params_type_ * 'a filter) -> ('a, 'an) params_type_
| TESuffix : string -> (string list, [ `One of string list ] param_name) params_type_
| TESuffixs : string -> (string, [ `One of string ] param_name) params_type_
| TESuffixu : (string * 'a Eliom_common.To_and_of_shared.t) -> ('a, [ `One of 'a ] param_name) params_type_
| TSuffix : (bool * ('s, 'sn) params_type_) -> ('s, 'sn) params_type_
| TUnit : (unit, unit) params_type_
| TAny : ((string * string) list, unit) params_type_
| TConst : string -> (unit, [ `One of unit ] param_name) params_type_
| TNLParams : ('a, 'names) non_localized_params_ -> ('a, 'names) params_type_
| TJson : (string * 'a Deriving_Json.t option) -> ('a, [ `One of 'a ocaml ] param_name) params_type_
| TRaw_post_data : (raw, no_param_name) params_type_

Sourceand ('a, 'names) non_localized_params_ = {

name : string;
persistent : bool;
get : 'a option Polytables.key;
post : 'a option Polytables.key;
param : ('a, 'names) params_type_;

}

Sourcetype ('a, +'suff, 'an) non_localized_params = ('a, 'an) non_localized_params_ constraint 'suff = [< suff ]

Sourcetype ('a, +'suff, 'an) params_type = ('a, 'an) params_type_ constraint 'suff = [< suff ]

Sourceval int : string -> (int, [ `One of int ] param_name) params_type_

Sourceval int32 : string -> (int32, [ `One of int32 ] param_name) params_type_

Sourceval int64 : string -> (int64, [ `One of int64 ] param_name) params_type_

Sourceval float : string -> (float, [ `One of float ] param_name) params_type_

Sourceval bool : string -> (bool, [ `One of bool ] param_name) params_type_

Sourceval string : string -> (string, [ `One of string ] param_name) params_type_

Source

val file : 
  string ->
  (Eliom_lib.file_info, [ `One of Eliom_lib.file_info ] param_name)
    params_type_

Sourceval unit : (unit, unit) params_type_

Source

val coordinates : 
  string ->
  (coordinates, [ `One of coordinates ] param_name) params_type_

Source

val type_checker : 
  ('a -> unit) ->
  ('a, 'b) params_type_ ->
  ('a, 'b) params_type_

Source

val sum : 
  ('a, 'b) params_type_ ->
  ('c, 'd) params_type_ ->
  (('a, 'c) binsum, 'b * 'd) params_type_

Source

val prod : 
  ('a, 'b) params_type_ ->
  ('c, 'd) params_type_ ->
  ('a * 'c, 'b * 'd) params_type_

Source

val (**) : 
  ('a, 'b) params_type_ ->
  ('c, 'd) params_type_ ->
  ('a * 'c, 'b * 'd) params_type_

Sourceval opt : ('a, 'b) params_type_ -> ('a option, 'b) params_type_

Sourceval neopt : ('a, 'b) params_type_ -> ('a option, 'b) params_type_

Source

val radio : 
  (string -> ('a, 'b) params_type_) ->
  string ->
  ('a option, 'b) params_type_

Source

val list : 
  string ->
  ('a, 'b) params_type_ ->
  ('a list, 'b listnames) params_type_

Source

val set : 
  (string -> ('a, [ `One of 'b ] param_name) params_type_) ->
  string ->
  ('a list, [ `Set of 'b ] param_name) params_type_

Sourceval any : ((string * string) list, unit) params_type_

Sourceval suffix_const : string -> (unit, [ `One of unit ] param_name) params_type_

Source

val all_suffix : 
  string ->
  (string list, [ `One of string list ] param_name) params_type_

Source

val all_suffix_string : 
  string ->
  (string, [ `One of string ] param_name) params_type_

Source

val suffix : 
  ?redirect_if_not_suffix:bool ->
  ('a, 'b) params_type_ ->
  ('a, 'b) params_type_

Source

val suffix_prod : 
  ?redirect_if_not_suffix:bool ->
  ('s, [< `Endsuffix | `WithoutSuffix ], 'sn) params_type ->
  ('a, [ `WithoutSuffix ], 'an) params_type ->
  ('s * 'a, [ `WithSuffix ], 'sn * 'an) params_type

Source

val ocaml : 
  string ->
  'a Deriving_Json.t ->
  ('a, [ `One of 'a ocaml ] param_name) params_type_

Sourceval raw_post_data : (raw, no_param_name) params_type_

Sourceval make_list_suffix : int -> string

Sourceval make_suffix : 'a 'c. ('a, [< suff ], 'c) params_type -> 'a -> string list

Source

val aux : 
  'a 'c. ('a, [< suff ], 'c) params_type ->
  string list option ->
  (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t ->
  'a ->
  string ->
  string ->
  (string * Eliommod_parameters.field) list ->
  string list option
  * (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t
  * (string * Eliommod_parameters.field) list

Source

val construct_params_list_raw : 
  (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t ->
  ('a, [< suff ], 'b) params_type ->
  'a ->
  string list option
  * (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t
  * (string * Eliommod_parameters.field) list

Sourceval get_to_and_of : 'a 'c. ('a, [< suff ], 'c) params_type -> 'a to_and_of

Given a parameter type, get the two functions that converts from and to strings. You should only use this function on

options ;
basic types : int, int32, int64, float, string
marshal
unit
string
bool

Source

val walk_parameter_tree : 
  'a 'c. string ->
  ('a, [< suff ], 'c) params_type ->
  'a to_and_of option

Walk the parameter tree to search for a parameter, given its name

Sourceval construct_params_string : (string * string) list -> string

Source

val construct_params_list : 
  (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t ->
  ('a, [< suff ], 'b) params_type ->
  'a ->
  string list option * (string * Eliommod_parameters.field) list

Source

val construct_params : 
  (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t ->
  ('a, [< suff ], 'b) params_type ->
  'a ->
  string list option * string

Sourceval make_params_names : ('a, [< suff ], 'b) params_type -> bool * 'b

Sourceval string_of_param_name : 'a -> 'a

Source

val add_pref_params : 
  'a 'c. string ->
  ('a, [< suff ] as 'b, 'c) params_type ->
  ('a, 'b, 'c) params_type

Source

val nl_prod : 
  ('a, [< suff ] as 'b, 'an) params_type ->
  ('s, [ `WithoutSuffix ], 'sn) non_localized_params ->
  ('a * 's, 'b, 'an * 'sn) params_type

Source

val remove_from_nlp : 
  'a 'c. 'b Eliom_lib.String.Table.t ->
  ('a, [< suff ], 'c) params_type ->
  'b Eliom_lib.String.Table.t

Source

type nl_params_set =
  (string * Eliommod_parameters.param) list Eliom_lib.String.Table.t

Sourceval empty_nl_params_set : 'a Eliom_lib.String.Table.t

Source

val add_nl_parameter : 
  nl_params_set ->
  ('a, 'b) non_localized_params_ ->
  'a ->
  nl_params_set

Sourceval table_of_nl_params_set : 'a -> 'a

Source

val list_of_nl_params_set : 
  (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t ->
  (string * Eliommod_parameters.field) list

Source

val string_of_nl_params_set : 
  (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t ->
  string

Sourceval get_nl_params_names : ('a, 'b) non_localized_params_ -> 'b

Sourceval make_nlp_name : bool -> string -> string -> string

Source

val make_non_localized_parameters : 
  prefix:string ->
  name:string ->
  ?persistent:bool ->
  ('a, [ `WithoutSuffix ], 'b) params_type ->
  ('a, [ `WithoutSuffix ], 'b) non_localized_params

Sourceval contains_suffix : 'a 'c. ('a, [< suff ], 'c) params_type -> bool option

Source

val wrap_param_type : 
  'a 'c. ('a, [< suff ] as 'b, 'c) params_type ->
  ('a, 'b, 'c) params_type

Sourcetype _ is_unit =

| U_not : _ is_unit
| U_yes : unit is_unit

Sourceval is_unit : 'a 'c. ('a, [< suff ], 'c) params_type -> 'a is_unit

Sourcetype anon_params_type = int

Sourceval anonymise_params_type : ('a, [< suff ], 'c) params_type -> anon_params_type

Sourcetype files = (string * Eliom_lib.file_info) list

Sourcetype +'a res_reconstr_param =

| Res_ of 'a * params' * files
| Errors_ of (string * string * exn) list * params' * files

Sourceval end_of_list : (string * 'a) list -> string -> bool

Source

val reconstruct_params_ : 
  ('a, [< suff ], 'b) params_type ->
  params' ->
  files ->
  bool ->
  string list option ->
  'a

Source

val reconstruct_params : 
  sp:Eliom_common.server_params ->
  ('a, [< suff ], 'c) params_type ->
  params' Lwt.t option ->
  files Lwt.t option ->
  bool ->
  string list option ->
  'a Lwt.t

package eliom

Module Eliom_parameter_baseSource

Module `Eliom_parameter_base`Source