seekableInputStreamRegionAdapter Class Reference

#include <seekableInputStreamRegionAdapter.hpp>

Inheritance diagram for seekableInputStreamRegionAdapter:

Collaboration diagram for seekableInputStreamRegionAdapter:

Public Member Functions
	seekableInputStreamRegionAdapter (shared_ptr< seekableInputStream > stream, const size_t begin, const size_t length)
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 &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

An adapter for reading a limited region of a seekable input stream.

Constructor & Destructor Documentation

seekableInputStreamRegionAdapter()

seekableInputStreamRegionAdapter	(	shared_ptr< seekableInputStream >	stream,
		const size_t	begin,
		const size_t	length )

Creates a new adapter for a seekableInputStream.

Parameters

stream	source stream
begin	start position in source stream
length	region length in source stream

References vmime::begin().

Member Function Documentation

eof()

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.

getPosition()

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.

read()

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

virtual

Read data from the stream.

Parameters

data	will receive the data read
count	maximum number of bytes to read

Returns

number of bytes read

Implements inputStream.

References vmime::count().

reset()

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.

seek()

void seek ( const size_t pos )

virtual

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

Parameters

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

Implements seekableInputStream.

skip()

size_t skip ( const size_t count )

virtual

Skip a number of bytes.

Parameters

count

maximum number of bytes to ignore

Returns

number of bytes skipped

Implements inputStream.

References vmime::count().

---

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

• seekableInputStreamRegionAdapter.hpp
• seekableInputStreamRegionAdapter.cpp