Concept StreamConceptBase concept for streams.
Base concept for streams.
All Subcl's | BidirectionalStreamConcept, InputStreamConcept, OutputStreamConcept |
---|---|
Defined in | <seqan/basic.h> |
Signature |
concept StreamConcept;
|
Interface Function Overview
-
bool atEnd(stream);
Return whether stream is at the end. -
TDirIter directionIterator(stream, dirTag);
Returns direction iterator for Stream. -
TPosition position(stream);
Return current stream position. -
void setPosition(stream, pos);
Set stream position.
Interface Metafunction Overview
-
DirectionIterator<TStream>::Type;
Return the direction iterator for the given direction. -
Position<TStream>::Type;
Metafunction for retrieving the position type of a stream. -
Size<TStream>::Type;
Metafunction for retrieving the type of a stream. -
Value<TStream>::Type;
Metafunction for retrieving the value type of a stream.
Interface Functions Detail
bool atEnd(stream);
Return whether stream is at the end.
Parameters
stream
|
The stream to check. |
---|
Returns
bool |
true if the file at EOF, false otherwise. |
---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TDirIter directionIterator(stream, dirTag);
Returns direction iterator for Stream.
Parameters
stream
|
The StreamConcept object to compute iterator for. |
---|---|
dirTag
|
Direction tag, one of the DirectionTags. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TPosition position(stream);
Return current stream position.
Parameters
stream
|
The stream to query. |
---|
Returns
TPosition |
Current position in stream, see Position. |
---|
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
void setPosition(stream, pos);
Set stream position.
Parameters
stream
|
The stream to update |
---|---|
pos
|
The positoin to set. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.