package eliom

  1. Overview
  2. Docs
Advanced client/server Web and mobile framework

Install 

dune-project
 Dependency

ocsigen.org Readme Edit opam file Versions (33)

Authors

  1. D
    dev@ocsigen.org

Maintainers

  1. D
    dev@ocsigen.org

Sources

10.4.0.tar.gz
md5=87e171413ab2714514019b533f3f7ab3
sha512=e3ed10c599dd54bc5d4b1bf67debb7068f439d33e30dd39e5ed0cebbddd700b9765a751e16fa93dbd1fa6d934fbb6b2d1677fce817fbfea70565192a0a7e1025

doc/eliom.server/Eliom_parameter_base/index.html

Module Eliom_parameter_baseSource

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 =
  1. | Inj1 of 'a
  2. | Inj2 of 'b
Sourcetype 'an listnames = {
  1. it : 'el 'a. ('an -> 'el -> 'a -> 'a) -> 'el list -> 'a -> 'a;
}
Sourcetype coordinates = {
  1. abscissa : int;
  2. ordinate : int;
}
Sourcetype 'a setoneradio = [
  1. | `Set of 'a
  2. | `One of 'a
  3. | `Radio of 'a
]
Sourcetype 'a oneradio = [
  1. | `One of 'a
  2. | `Radio of 'a
]
Sourcetype 'a setone = [
  1. | `Set of 'a
  2. | `One of 'a
]
Sourcetype 'a to_and_of = {
  1. of_string : string -> 'a;
  2. to_string : 'a -> string;
}
Sourcetype _ atom =
  1. | TFloat : float atom
  2. | TInt : int atom
  3. | TInt32 : int32 atom
  4. | TInt64 : int64 atom
  5. | TNativeint : nativeint atom
  6. | TBool : bool atom
  7. | 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
Sourcetype raw = ((string * string) * (string * string) list) option * Cohttp_lwt.Body.t
Sourcetype 'a ocaml = string
Sourcetype suff = [
  1. | `WithoutSuffix
  2. | `WithSuffix
  3. | `Endsuffix
]
Sourcetype (_, _) params_type_ =
  1. | TProd : (('a, 'an) params_type_ * ('b, 'bn) params_type_) -> ('a * 'b, 'an * 'bn) params_type_
  2. | TOption : (('a, 'an) params_type_ * bool) -> ('a option, 'an) params_type_
  3. | TList : (string * ('a, 'an) params_type_) -> ('a list, 'an listnames) params_type_
  4. | TSet : ('a, [ `One of 'an ] param_name) params_type_ -> ('a list, [ `Set of 'an ] param_name) params_type_
  5. | TSum : (('a, 'an) params_type_ * ('b, 'bn) params_type_) -> (('a, 'b) binsum, 'an * 'bn) params_type_
  6. | TAtom : (string * 'a atom) -> ('a, [ `One of 'a ] param_name) params_type_
  7. | TCoord : string -> (coordinates, [ `One of coordinates ] param_name) params_type_
  8. | TFile : string -> (Eliom_lib.file_info, [ `One of Eliom_lib.file_info ] param_name) params_type_
  9. | TUserType : (string * 'a Eliom_common.To_and_of_shared.t) -> ('a, [ `One of 'a ] param_name) params_type_
  10. | TTypeFilter : (('a, 'an) params_type_ * 'a filter) -> ('a, 'an) params_type_
  11. | TESuffix : string -> (string list, [ `One of string list ] param_name) params_type_
  12. | TESuffixs : string -> (string, [ `One of string ] param_name) params_type_
  13. | TESuffixu : (string * 'a Eliom_common.To_and_of_shared.t) -> ('a, [ `One of 'a ] param_name) params_type_
  14. | TSuffix : (bool * ('s, 'sn) params_type_) -> ('s, 'sn) params_type_
  15. | TUnit : (unit, unit) params_type_
  16. | TAny : ((string * string) list, unit) params_type_
  17. | TConst : string -> (unit, [ `One of unit ] param_name) params_type_
  18. | TNLParams : ('a, 'names) non_localized_params_ -> ('a, 'names) params_type_
  19. | TJson : (string * 'a Deriving_Json.t option) -> ('a, [ `One of 'a ocaml ] param_name) params_type_
  20. | TRaw_post_data : (raw, no_param_name) params_type_
Sourceand ('a, 'names) non_localized_params_ = {
  1. name : string;
  2. persistent : bool;
  3. get : 'a option Polytables.key;
  4. post : 'a option Polytables.key;
  5. 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_
Sourceval unit : (unit, unit) params_type_
Sourceval coordinates : string -> (coordinates, [ `One of coordinates ] param_name) params_type_
Sourceval type_checker : ('a -> unit) -> ('a, 'b) params_type_ -> ('a, 'b) params_type_
Sourceval sum : ('a, 'b) params_type_ -> ('c, 'd) params_type_ -> (('a, 'c) binsum, 'b * 'd) params_type_
Sourceval prod : ('a, 'b) params_type_ -> ('c, 'd) params_type_ -> ('a * 'c, 'b * 'd) params_type_
Sourceval (**) : ('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_
Sourceval radio : (string -> ('a, 'b) params_type_) -> string -> ('a option, 'b) params_type_
Sourceval list : string -> ('a, 'b) params_type_ -> ('a list, 'b listnames) params_type_
Sourceval 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_
Sourceval all_suffix : string -> (string list, [ `One of string list ] param_name) params_type_
Sourceval all_suffix_string : string -> (string, [ `One of string ] param_name) params_type_
Sourceval suffix : ?redirect_if_not_suffix:bool -> ('a, 'b) params_type_ -> ('a, 'b) params_type_
Sourceval 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
Sourceval 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
Sourceval 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
Sourceval 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
Sourceval 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
Sourceval 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
Sourceval 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
Sourceval add_pref_params : 'a 'c. string -> ('a, [< suff ] as 'b, 'c) params_type -> ('a, 'b, 'c) params_type
Sourceval nl_prod : ('a, [< suff ] as 'b, 'an) params_type -> ('s, [ `WithoutSuffix ], 'sn) non_localized_params -> ('a * 's, 'b, 'an * 'sn) params_type
Sourceval remove_from_nlp : 'a 'c. 'b Eliom_lib.String.Table.t -> ('a, [< suff ], 'c) params_type -> 'b Eliom_lib.String.Table.t
Sourcetype nl_params_set = (string * Eliommod_parameters.param) list Eliom_lib.String.Table.t
Sourceval empty_nl_params_set : 'a Eliom_lib.String.Table.t
Sourceval add_nl_parameter : nl_params_set -> ('a, 'b) non_localized_params_ -> 'a -> nl_params_set
Sourceval table_of_nl_params_set : 'a -> 'a
Sourceval list_of_nl_params_set : (string * Eliommod_parameters.field) list Eliom_lib.String.Table.t -> (string * Eliommod_parameters.field) list
Sourceval 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
Sourceval 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
Sourceval wrap_param_type : 'a 'c. ('a, [< suff ] as 'b, 'c) params_type -> ('a, 'b, 'c) params_type
Sourcetype _ is_unit =
  1. | U_not : _ is_unit
  2. | 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 =
  1. | Res_ of 'a * params' * files
  2. | Errors_ of (string * string * exn) list * params' * files
Sourceval end_of_list : (string * 'a) list -> string -> bool
Sourceval reconstruct_params_ : ('a, [< suff ], 'b) params_type -> params' -> files -> bool -> string list option -> 'a
Sourceval 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