Ocsigen

Reference manual

Version 1.3.0

Index

Lwt
Lwt API reference
Eliom
Main modules
Pages with Ocamlduce
XHTML pages typed with variants
Other pages
Creating new kinds of pages
Ocsigen

This is a preliminary version of the documentation. Help us to improve it by filling tickets. We are looking for native english speakers to proof read the documentation. Contact us!

sig
  type 'a t
  val from : (unit -> 'a option Lwt.t) -> 'a Lwt_stream.t
  val push_stream :
    unit ->
    ([ `Data of 'a | `End_of_stream | `Exn of exn ] -> unit) *
    'a Lwt_stream.t
  val of_list : 'a list -> 'a Lwt_stream.t
  val of_string : string -> char Lwt_stream.t
  val of_event : 'a React.event -> 'a Lwt_stream.t
  val clone : 'a Lwt_stream.t -> 'a Lwt_stream.t
  val to_list : 'a Lwt_stream.t -> 'a list Lwt.t
  val to_string : char Lwt_stream.t -> string Lwt.t
  exception Empty
  val peek : 'a Lwt_stream.t -> 'a option Lwt.t
  val npeek : int -> 'a Lwt_stream.t -> 'a list Lwt.t
  val get : 'a Lwt_stream.t -> 'a option Lwt.t
  val nget : int -> 'a Lwt_stream.t -> 'a list Lwt.t
  val get_while : ('a -> bool) -> 'a Lwt_stream.t -> 'a list Lwt.t
  val get_while_s : ('a -> bool Lwt.t) -> 'a Lwt_stream.t -> 'a list Lwt.t
  val next : 'a Lwt_stream.t -> 'a Lwt.t
  val junk : 'a Lwt_stream.t -> unit Lwt.t
  val njunk : int -> 'a Lwt_stream.t -> unit Lwt.t
  val junk_while : ('a -> bool) -> 'a Lwt_stream.t -> unit Lwt.t
  val junk_while_s : ('a -> bool Lwt.t) -> 'a Lwt_stream.t -> unit Lwt.t
  val junk_old : 'a Lwt_stream.t -> unit Lwt.t
  val get_available : 'a Lwt_stream.t -> 'a list
  val get_available_up_to : int -> 'a Lwt_stream.t -> 'a list
  val is_empty : 'a Lwt_stream.t -> bool Lwt.t
  val choose : 'a Lwt_stream.t list -> 'a Lwt_stream.t
  val map : ('a -> 'b) -> 'a Lwt_stream.t -> 'b Lwt_stream.t
  val map_s : ('a -> 'b Lwt.t) -> 'a Lwt_stream.t -> 'b Lwt_stream.t
  val filter : ('a -> bool) -> 'a Lwt_stream.t -> 'a Lwt_stream.t
  val filter_s : ('a -> bool Lwt.t) -> 'a Lwt_stream.t -> 'a Lwt_stream.t
  val filter_map : ('a -> 'b option) -> 'a Lwt_stream.t -> 'b Lwt_stream.t
  val filter_map_s :
    ('a -> 'b option Lwt.t) -> 'a Lwt_stream.t -> 'b Lwt_stream.t
  val map_list : ('a -> 'b list) -> 'a Lwt_stream.t -> 'b Lwt_stream.t
  val map_list_s :
    ('a -> 'b list Lwt.t) -> 'a Lwt_stream.t -> 'b Lwt_stream.t
  val fold : ('a -> 'b -> 'b) -> 'a Lwt_stream.t -> 'b -> 'b Lwt.t
  val fold_s : ('a -> 'b -> 'b Lwt.t) -> 'a Lwt_stream.t -> 'b -> 'b Lwt.t
  val iter : ('a -> unit) -> 'a Lwt_stream.t -> unit Lwt.t
  val iter_p : ('a -> unit Lwt.t) -> 'a Lwt_stream.t -> unit Lwt.t
  val iter_s : ('a -> unit Lwt.t) -> 'a Lwt_stream.t -> unit Lwt.t
  val find : ('a -> bool) -> 'a Lwt_stream.t -> 'a option Lwt.t
  val find_s : ('a -> bool Lwt.t) -> 'a Lwt_stream.t -> 'a option Lwt.t
  val find_map : ('a -> 'b option) -> 'a Lwt_stream.t -> 'b option Lwt.t
  val find_map_s :
    ('a -> 'b option Lwt.t) -> 'a Lwt_stream.t -> 'b option Lwt.t
  val combine : 'a Lwt_stream.t -> 'b Lwt_stream.t -> ('a * 'b) Lwt_stream.t
  val append : 'a Lwt_stream.t -> 'a Lwt_stream.t -> 'a Lwt_stream.t
  val concat : 'a Lwt_stream.t Lwt_stream.t -> 'a Lwt_stream.t
  val flatten : 'a list Lwt_stream.t -> 'a Lwt_stream.t
  val parse : 'a Lwt_stream.t -> ('a Lwt_stream.t -> 'b Lwt.t) -> 'b Lwt.t
  val hexdump : char Lwt_stream.t -> string Lwt_stream.t
end