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.10.1.tar.gz

md5=4cf944bcae5d36bf47b67f6bcb2455d7

sha512=0262b5768aefd7c080f664c46c88876fce9a658cc6a87358a77b7112c49ae3042e7ab542e76be5738fbaeda853149b308b48d4897960b5c7ae3b4da71d978bd8

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

Module `Lines.Parser`

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.

type state

Parser state

val initial_state : state

The initial state to be fed to the step function.

val 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

val 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.