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

md5=486aeb3e552dabae85839e2af30d6c52

sha512=4ed2df0b7cbd80bd6e29bd8fee9d2dacd9379ad0f4ff142bd8e16ade3f1507f6cc7cbe4c614943b8feb8fa4705935695cb458606b0da813dbf255b1e566a43cf

doc/biocaml.unix/Biocaml_unix/Lines/Buffer/index.html

Module `Lines.Buffer`Source

Buffer used to parse strings into lines.

Sourcetype t

The buffer handle.

Sourceexception No_next_line

The exception thrown by next_line_exn.

Sourceval make : ?filename:string -> unit -> t

Make a new empty buffer. The optional filename is used only for error reporting; it should be set to the name of the file, if any, from which you will feed the buffer.

Sourceval feed_line : t -> item -> unit

Feed the parser with a line.

Sourceval feed_string : t -> string -> unit

Feed the parser with an arbitrary string buffer.

Sourceval queued_lines : t -> int

Get the number of lines ready-to-use in the buffer/queue.

Sourceval is_empty : t -> bool

Tell if the parser's buffers are empty or not. For instance, when there is no more content to feed and next_line returns None, is_empty p = true means that the content did not end with a complete line.

Sourceval peek_line : t -> item option

Peek at the next line, without removing it from the buffer.

Sourceval next_line : t -> item option

Get the next line.

Sourceval next_line_exn : t -> item

Get the next line, but throw No_next_line if there is no line to return.

Sourceval current_position : t -> Pos.t

Get the current position in the stream.

Sourceval contents : t -> item list * string option

Return any remaining lines and the unfinished string, without removing them from the buffer.

Sourceval empty : t -> unit

Empty the buffer. Subsequent call to contents will return ([], None).