Module LineShtream

module LineShtream: sig .. end

Shtreams of Line.ts. This module is the result of applying AnyShtream.Make to the module LineShtream.LineElem. Thus, shtreams handled by this module are compatible with the shtreams of Shtream, StringShtream, and modules created by AnyShtream.Make, but this module provides additional functions for reading and writing Line.t Shtream.ts.

This module specializes shtream-creating functions to store source information in the resulting lines.

type sourced = Line.t

A line with source and sequence information. This is the AnyShtream.ELEM.initial type for LineShtream.

module LineElem: AnyShtream.ELEM 
  with type 'a elem = Line.t
   and type initial = sourced

The parameter given to AnyShtream.Make to build LineShtream.

include AnyShtream.S with module Elem = LineElem

Most of the types and values in LineShtream come from the result of apply AnyShtream.Make.

val line_reader : ?source:Line.source -> Reader.t -> Pervasives.in_channel -> initial elem

Construct a Line.t reader from a record reader. This is like AnyShtream.S.elem_reader, but allows specifying a Line.source to store in the lines.

val annotate : Line.source -> Line.t t -> Line.t t

Annotate a shtream of lines with source and sequence information. If the lines already have seq or source fields, these are rewritten to reflect the given Line.source and current sequence.