package biocaml

You can search for identifiers within the package.

in-package search v0.2.0

The OCaml Bioinformatics Library

Install

Dune Dependency

biocaml.org Readme Edit opam file Versions (5)

Authors

Maintainers

B

biocaml@googlegroups.com

Sources

v0.11.1.tar.gz

md5=e292efa2f61fec33dad63ec897106f59

sha512=35519bf3b1e67a9191ef9bb74eba0dae941e0d05bad89076a36f507dc5c2d105a03c1c917d5a3f7ed9d1da4acbf3199582f78c308aa2a5a22c21f743945c852b

doc/biocaml.base/Biocaml_base/Lines/Parser/index.html

Module `Lines.Parser`Source

A parser for lines

This module provides building blocks for a line parser, especially a step function, that given the state of the parser and a chunk of bytes returns a list of lines and a new state. This API is meant to be usable from various contexts, including async or lwt.

Sourcetype state

Parser state

Sourceval initial_state : state

The initial state to be fed to the step function.

Sourceval line_number : state -> Base.int

Number of lines seen so far. We have line_number initial_state = 0, and line_number (fst (step _ (Some _))) > 0

Sourceval step : state -> Base.string Base.option -> state * Line.t Base.list

step st i parses an input. If i = None, the caller indicates that there is no more input; in that case the returned state is terminal: all inputs read from this state will be ignored.