package biocaml

You can search for identifiers within the package.

in-package search v0.2.0

The OCaml Bioinformatics Library

Install

Dune Dependency

github.com Readme Edit opam file Versions (5)

Authors

Maintainers

P

philippe.veber@gmail.com

Sources

biocaml-0.11.2.tbz

sha256=fae219e66db06f81f3fd7d9e44717ccf2d6d85701adb12004ab4ae6d3359dd2d

sha512=f6abd60dac2e02777be81ce3b5acdc0db23b3fa06731f5b2d0b32e6ecc9305fe64f407bbd95a3a9488b14d0a7ac7c41c73a7e18c329a8f18febfc8fd50eccbc6

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.