input

Type Members

1. class CharArrayReader extends CharSequenceReader

   

   A character array reader reads a stream of characters (keeping track of their positions) from an array.

2. class CharSequenceReader extends Reader[Char]

   

   A character array reader reads a stream of characters (keeping track of their positions) from an array.

3. case class OffsetPosition(source: CharSequence, offset: Int) extends Position with Product with Serializable

   

   OffsetPosition is a standard class for positions represented as offsets into a source document.

   OffsetPosition is a standard class for positions represented as offsets into a source document.

   source

   The source document

   offset

   The offset indicating the position

4. class PagedSeq[T] extends AbstractSeq[T] with collection.IndexedSeq[T] with ScalaVersionSpecificPagedSeq[T]

   

   An implementation of lazily computed sequences, where elements are stored in "pages", i.e.

   An implementation of lazily computed sequences, where elements are stored in "pages", i.e. arrays of fixed size.

   A paged sequence is constructed from a function that produces more elements when asked. The producer function - more, is similar to the read method in java.io.Reader. The more function takes three parameters: an array of elements, a start index, and an end index. It should try to fill the array between start and end indices (excluding end index). It returns the number of elements produced, or -1 if end of logical input stream was reached before reading any element.

   T

   the type of the elements contained in this paged sequence, with an ClassTag context bound.

5. class PagedSeqReader extends Reader[Char]

   

   A character array reader reads a stream of characters (keeping track of their positions) from an array.

6. trait Position extends AnyRef

   

   Position is the base trait for objects describing a position in a document.

   Position is the base trait for objects describing a position in a document.

   It provides functionality for:

   • generating a visual representation of this position (longString);
   • comparing two positions (<).

   To use this class for a concrete kind of document, implement the lineContents method.

7. trait Positional extends AnyRef

   

   A trait for objects that have a source position.

8. abstract class Reader[+T] extends AnyRef

   

   An interface for streams of values that have positions.

9. sealed class StreamReader extends PagedSeqReader

   

   A StreamReader reads from a character sequence, typically created as a PagedSeq from a java.io.Reader

   A StreamReader reads from a character sequence, typically created as a PagedSeq from a java.io.Reader

   NOTE: StreamReaders do not really fulfill the new contract for readers, which requires a source CharSequence representing the full input. Instead source is treated line by line. As a consequence, regex matching cannot extend beyond a single line when a StreamReader are used for input.

   If you need to match regexes spanning several lines you should consider class PagedSeqReader instead.