VMime
inputStreamAdapter Class Reference
Inheritance diagram for inputStreamAdapter:
Collaboration diagram for inputStreamAdapter:

Public Member Functions

 inputStreamAdapter (std::istream &is)
 
bool eof () const
 
void reset ()
 
size_t read (byte_t *const data, const size_t count)
 
size_t skip (const size_t count)
 
size_t getPosition () const
 
void seek (const size_t pos)
 
- Public Member Functions inherited from stream
virtual ~stream ()
 
virtual size_t getBlockSize ()
 

Additional Inherited Members

- Protected Member Functions inherited from object
 object ()
 
 object (const object &)
 
objectoperator= (const object &)
 
virtual ~object ()
 

Detailed Description

An adapter class for C++ standard input streams.

Constructor & Destructor Documentation

inputStreamAdapter ( std::istream &  is)
Parameters
isinput stream to wrap

Member Function Documentation

bool eof ( ) const
virtual

Test for end of stream (no more data to read).

Returns
true if we have reached the end of stream, false otherwise

Implements inputStream.

size_t getPosition ( ) const
virtual

Returns the current position in this stream.

Returns
the offset from the beginning of the stream, in bytes, at which the next read occurs

Implements seekableInputStream.

size_t read ( byte_t *const  data,
const size_t  count 
)
virtual

Read data from the stream.

Parameters
datawill receive the data read
countmaximum number of bytes to read
Returns
number of bytes read

Implements inputStream.

void reset ( )
virtual

Set the read pointer to the beginning of the stream.

Warning
WARNING: this may not work for all stream types.

Implements inputStream.

void seek ( const size_t  pos)
virtual

Sets the position, measured from the beginning of this stream, at which the next read occurs.

Parameters
posthe offset position, measured in bytes from the beginning of the stream, at which to set the stream pointer.

Implements seekableInputStream.

size_t skip ( const size_t  count)
virtual

Skip a number of bytes.

Parameters
countmaximum number of bytes to ignore
Returns
number of bytes skipped

Implements inputStream.


The documentation for this class was generated from the following files: