Class LimitRecordReaderInScope

Manipulates a RecordReader -Object so that it operates only on the first buffer

/*!
 * @class LimitRecordReaderInScope
 * 
 * @headerfile <seqan/seq_io.h>
 * 
 * @brief Manipulates a @link RecordReader @endlink -Object so that it operates
 *        only on the first buffer
 * 
 * @signature template <typename TStream, typename TSpec> class
 *            LimitRecordReaderInScope;
 * 
 * @tparam TSpec The specialization of the @link RecordReader @endlink.
 * @tparam TStream The @link StreamConcept @endlink of the @link RecordReader
 *                 @endlink.
 * 
 * This class is intended for situations, where you do not wish the RecordReader
 * to rebuffer and where you wish to return to the original reading position
 * after reading, e.g. when detecting the file format of the stream.
 * 
 * It is used by passing the RecordReader-object on construction (this already
 * does the necessary changes in the RecordReader). Upon deconstruction of this
 * object, the RecordReader is reset to its original state, including all
 * iterators.
 * 
 * This works on all RecordReader-objects, independent of the underlying stream-
 * object. It also works if the underlying stream does not support seeking.
 * 
 * @see RecordReader
 * @see guessStreamFormat
 */