package rocq-runtime
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=b236dc44f92e1eeca6877c7ee188a90c2303497fe7beb99df711ed5a7ce0d824
doc/rocq-runtime.gramlib/Gramlib/Stream/index.html
Module Gramlib.StreamSource
Streams and parsers.
The type of streams holding values of type 'a. Producing a new value needs an environment 'e.
Raised by streams when trying to access beyond their end.
Stream builders
Stream.from f returns a stream built from the function f. To create a new stream element, the function f is called. The user function f must return either Some <value> for a value or None to specify the end of the stream. offset will initialize the stream count to start with offset consumed items, which is useful for some uses cases such as parsing resumption.
Return the stream holding the elements of the list in the same order.
Return the stream of the characters of the string parameter. If set. offset parameter is similar to from.
Return the stream of the characters read from the input channel.
Predefined parsers
Return the first element of the stream and remove it from the stream.
Useful functions
Return Some of "the first element" of the stream, or None if the stream is empty.
Remove the first element of the stream, possibly unfreezing it before.
Return the current count of the stream elements, i.e. the number of the stream elements discarded.
npeek e n returns the list of the n first elements of the stream, or all its remaining elements if less than n elements are available.