Module `Eliom.Lib`

Eliom standard library

See Ocsigen_lib_base.

include module type of Ocsigen_lib_base
  with type poly = Ocsigen_lib_base.poly
   and type yesnomaybe = Ocsigen_lib_base.yesnomaybe
   and type 'a Clist.t = 'a Ocsigen_lib_base.Clist.t
   and type 'a Clist.node = 'a Ocsigen_lib_base.Clist.node

exception Ocsigen_Internal_Error of string

exception Input_is_too_large

exception Ocsigen_Bad_Request

exception Ocsigen_Request_too_long

include module type of Lwt.Infix

val (>>=) : 'a Lwt.t -> ('a -> 'b Lwt.t) -> 'b Lwt.t

p >>= f is the same as Lwt.bind p f. It requires Lwt.Infix to be opened in scope:

open Lwt.Infix

let () =
  Lwt_main.run
    (Lwt_io.(read_line stdin) >>= Lwt_io.printl)

(* ocamlfind opt -linkpkg -thread -package lwt.unix code.ml && ./a.out *)

It is recommended to use the PPX let%lwt syntax instead. This operator is the next-best choice. It is frequently found while reading existing Lwt code.

val (>|=) : 'a Lwt.t -> ('a -> 'b) -> 'b Lwt.t

p >|= f is the same as Lwt.map f p. It requires Lwt.Infix to be opened in scope.

open Lwt.Infix

let () =
  Lwt_main.run
    (Lwt_io.(read_line stdin) >|= ignore)

(* ocamlfind opt -linkpkg -thread -package lwt.unix code.ml && ./a.out *)

val (<&>) : unit Lwt.t -> unit Lwt.t -> unit Lwt.t

p1 <&> p2 is the same as Lwt.join [p1; p2]. It requires Lwt.Infix to be opened in scope.

Unlike with Lwt.bind and Lwt.map, there are no problems with explicit Lwt.join syntax, so using this operator is not recommended.

val (<?>) : 'a Lwt.t -> 'a Lwt.t -> 'a Lwt.t

p1 <?> p2 is the same as Lwt.choose [p1; p2]. It requires Lwt.Infix to be opened in scope.

Unlike with Lwt.bind and Lwt.map, there are no problems with explicit Lwt.choose syntax, so using this operator is not recommended.

Furthermore, most users actually need Lwt.pick instead of Lwt.choose.

val (=<<) : ('a -> 'b Lwt.t) -> 'a Lwt.t -> 'b Lwt.t

f =<< p is the same as Lwt.bind p f. It requires Lwt.Infix to be opened in scope.

This operator is obscure and its use is discouraged. It is the same as p >>= f.

val (=|<) : ('a -> 'b) -> 'a Lwt.t -> 'b Lwt.t

f =|< p is the same as Lwt.map f p. It requires Lwt.Infix to be opened in scope.

This operator is obscure and its use is discouraged. It is the same as p >|= f.

module Let_syntax : sig ... end

This module provides support for ppx_let.

val (!!) : 'a Lazy.t -> 'a

val comp : ('a -> 'b) -> ('c -> 'a) -> 'c -> 'b

val curry : (('a * 'b) -> 'c) -> 'a -> 'b -> 'c

val uncurry : ('a -> 'b -> 'c) -> ('a * 'b) -> 'c

module Tuple3 : sig ... end

type poly = Ocsigen_lib_base.poly

val to_poly : 'a -> poly

val from_poly : poly -> 'a

type yesnomaybe = Ocsigen_lib_base.yesnomaybe =

| Yes
| No
| Maybe

val advert : string

module List : sig ... end

Improvement of module List

module Clist : sig ... end

Circular lists

module Int : sig ... end

module String_base : sig ... end

Improvement of module String

module Url_base : sig ... end

val debug : string -> unit

include module type of Lib_base
  with type 'a Int64_map.t = 'a Lib_base.Int64_map.t
  with type 'a String_map.t = 'a Lib_base.String_map.t
  with type 'a Int_map.t = 'a Lib_base.Int_map.t

exception Eliom_Internal_Error of string

module type Map_S = sig ... end

module Int64_map : 
  Map_S with type key = int64 with type 'a t = 'a Lib_base.Int64_map.t

module Int_map : 
  Map_S with type key = int with type 'a t = 'a Lib_base.Int_map.t

module String_map : 
  Map_S with type key = string with type 'a t = 'a Lib_base.String_map.t

type file_info = Js_of_ocaml.File.file Js_of_ocaml.Js.t

val to_json : ?typ:'a Deriving_Json.t -> 'a -> string

val of_json : ?typ:'a Deriving_Json.t -> string -> 'a

module Url : sig ... end

URL manipulation

module String : sig ... end

Extension of Ocsigen_lib_base.String_base.

val raise_error : 
  ?exn:exn ->
  ?section:Logs.src ->
  ('a, unit, string, 'any) format4 ->
  'a

val log_inspect : 'a -> unit

Print an object in the console.

val eliom_logs_src : Logs.src

Log section for logs generated by Eliom.

val alert : ('a, unit, string, unit) format4 -> 'a

val jsalert : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t -> unit

val confirm : ('a, unit, string, bool) format4 -> 'a

val debug_var : string -> 'a -> unit

val trace : ('a, unit, string, unit) format4 -> 'a

val unmarshal_js : Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t -> 'a

val encode_header_value : typ:'a Deriving_Json.t -> 'a -> string

val make_cryptographic_safe_string : ?len:int -> unit -> string

Return a base-64 encoded cryptographic safe string of the given length. Not implemented client-side.

module Dom_reference : sig ... end