blob: 1778a452331da0880b952e441e2a8c3316cb5bc3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
(***********************************************************************)
(* *)
(* Caml Special Light *)
(* *)
(* Daniel de Rauglaudre, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 1995 Institut National de Recherche en Informatique et *)
(* Automatique. Distributed only by permission. *)
(* *)
(***********************************************************************)
(* $Id$ *)
(* Module [Stream]: streams and stream parsers operations *)
type 'a t
(* The type of streams containing values of type ['a]. *)
exception Parse_failure
(* Raised by parsers when none of the first components of the stream
patterns is accepted. *)
exception Parse_error of string
(* Raised by parsers when the first component of a stream pattern is
accepted, but one of the following components is rejected. *)
val next : 'a t -> 'a
(* Returns the first element of the stream and removes it from the
stream. Raises [Parse_failure] if the stream is empty. *)
val empty : 'a t -> unit
(* Returns [()] if the stream is empty, else raises [Parse_failure]. *)
val peek : 'a t -> 'a option
(* Returns [Some] "the first element" of the stream, or [None] if the
stream is empty. *)
val count : 'a t -> int
(* Returns the count of elements of the stream (starting from 0). *)
val from : (int -> 'a option) -> 'a t
(* [Stream.from f] returns a stream built from the function [f].
To create a new stream element, the function [f] is called with
the current stream count. The user function [f] must return either
[Some <value>] for a value or [None] to specify the end of the
stream. *)
val of_list : 'a list -> 'a t
(* Returns the stream holding the elements of the list in the same
order. *)
val of_string : string -> char t
(* Returns the character stream of the string parameter. *)
val of_channel : in_channel -> char t
(* Returns the characters stream read from the input channel. *)
(*--*)
(*** For system use only, not for the casual user *)
val junk : 'a t -> unit
val sempty : 'a t
val scons : (unit -> 'a) -> 'a t -> 'a t
val sapp : (unit -> 'a t) -> 'a t -> 'a t
val dump : ('a -> unit) -> 'a t -> unit
|
