Single-Pass String RecordReader

Class Specialization

Record reader specialization for single-pass reading from memory mapped files.



RecordReader

Single-Pass RecordReader

Single-Pass String RecordReader

RecordReader<TStream, SinglePass<StringReader> >

Include Headers

seqan/stream.h

Parameters

TStream

The StreamConcept type to work on.

Remarks

This record reader does not have any buffers but uses the memory mapped string directly.

Is not default or copy constructable.

The buffer size is the granularity in which mmapAdvise will be called if TString is an MMap String.

Specialization of

Single-Pass RecordReader

Member Functions

RecordReader

Constructor (RecordReader)

Functions

atEnd	Returns true if there is no more data to be read. (RecordReader)
countLine	count characters in a line not including \r and \n (RecordReader)
goNext	Advance record reader to next position. (RecordReader)
guessStreamFormat	check whether the data provided by reader is (one of) the specified format(s). (RecordReader)
nextIs	Query whether the next record is of a given type. (RecordReader)
position	Returns the current position of the reader. (RecordReader)
read2	reads an entire document from a StreamConcept, by the means of RecordReader (RecordReader)
readAlphaNums	Read characters from stream as long as characters are letters (RecordReader)
readDigits	Read characters from stream as long as characters are digits (RecordReader)
readDna5IgnoringWhitespaces	Read characters from stream, as long as they are DNA5 characters. Skip over whitespaces. (RecordReader)
readFloat	Read characters from stream as long as the number is a valid floating point numbers. (RecordReader)
readGraphs	Read characters from stream as long as characters are graph characters. (RecordReader)
readIdentifier	Read characters from stream as long as characters are identifiers (alphanumeric, '-', and '_'). (RecordReader)
readLetters	Read characters from stream as long as characters are letters (RecordReader)
readLine	Read a line from stream and save it to buffer (RecordReader)
readLineStripTrailingBlanks	Read a line from stream and save it to buffer, remove trailing blanks (RecordReader)
readNChars	Read exactly n characters from stream into buffer (RecordReader)
readNCharsIgnoringWhitespace	Read n characters from stream into buffer, but skip certain Chars (RecordReader)
readRecord	reads one record (e.g. a single DNA-sequence and its meta data) from a StreamConcept, by the means of RecordReader (RecordReader)
readUntilBlank	Read characters from stream into buffer until Blank is encountered (RecordReader)
readUntilChar	Read characters from stream into buffer until Char is encountered (RecordReader)
readUntilOneOf	Read characters from stream into buffer until one of the given characters is encountered (RecordReader)
readUntilTabOrLineBreak	Read characters from stream until a tab or line-break occurs. (RecordReader)
readUntilWhitespace	Read characters from stream into buffer until Whitespace is encountered (RecordReader)
resultCode	Returns int current status code for reader (0 on success). (RecordReader)
setPosition	Returns the current position of the reader. (RecordReader)
skipBlanks	Skip (i.e. read without saving) characters from stream until non-Blank is encountered (RecordReader)
skipChar	Skip one character that must be equal to a given one for this function to succeed. (RecordReader)
skipLine	Skip a line in stream and go to beginning of next (RecordReader)
skipNChars	Skip exactly n characters from stream (RecordReader)
skipNCharsIgnoringWhitespace	Skip n characters from stream, not counting whitespaces (RecordReader)
skipUntilBlank	Skip (i.e. read without saving) characters from stream until Blank is encountered (RecordReader)
skipUntilChar	Skip (i.e. read without saving) characters from stream until Char is encountered (RecordReader)
skipUntilGraph	Skip (i.e. read without saving) characters from stream until printable, non-' ' character is encountered (RecordReader)
skipUntilLineBeginsWithChar	Skip input until the first graphical(see isgraph) character of a line is equal to c (RecordReader)
skipUntilLineBeginsWithOneCharOfStr	Skip input until a line begins with a one of the characters in str (RecordReader)
skipUntilLineBeginsWithStr	Skip input until a line begins with str. (RecordReader)
skipUntilString	Skip (i.e. read without saving) characters from stream until String is encountered (RecordReader)
skipUntilWhitespace	Skip (i.e. read without saving) characters from stream until Whitespace is encountered (RecordReader)
skipWhitespaces	Skip (i.e. read without saving) characters from stream until non-Whitespace is encountered (RecordReader)
value	Returns the current value of the reader. (RecordReader)