package ocaml-base-compiler
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c2d706432f93ba85bd3383fa451d74543c32a4e84a1afaf3e8ace18f7f097b43
doc/stdlib/Stdlib/Stream/index.html
Module Stdlib.Stream
Source
Streams and parsers.
The type of streams holding values of type 'a
.
Raised by parsers when none of the first components of the stream patterns is accepted.
Raised by parsers when the first component of a stream pattern is accepted, but one of the following components is rejected.
Stream builders
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.
Do note that the indices passed to f
may not start at 0
in the general case. For example, [< '0; '1; Stream.from f >]
would call f
the first time with count 2
.
Return the stream holding the elements of the list in the same order.
Return the stream of the characters read from the input channel.
Stream iterator
Stream.iter f s
scans the whole stream s, applying function f
in turn to each stream element encountered.
Predefined parsers
Return ()
if the stream is empty, else raise Stream.Failure
.
Useful functions
Return Some
of "the first element" of the stream, or None
if the stream is empty.
Return the current count of the stream elements, i.e. the number of the stream elements discarded.