dotFilteredInputStream Class Reference

#include <filteredStream.hpp>

Inheritance diagram for dotFilteredInputStream:

Collaboration diagram for dotFilteredInputStream:

Public Member Functions
	dotFilteredInputStream (inputStream &is)
inputStream &	getPreviousInputStream ()
bool	eof () const
void	reset ()
size_t	read (byte_t *const data, const size_t count)
size_t	skip (const size_t count)
Public Member Functions inherited from filteredInputStream
virtual size_t	getBlockSize ()
Public Member Functions inherited from stream
virtual	~stream ()

Additional Inherited Members
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

A filtered input stream which replaces "\n.." sequences with "\n." sequences.

Constructor & Destructor Documentation

dotFilteredInputStream()

dotFilteredInputStream

(

inputStream &

is

)

Construct a new filter for the specified input stream.

Parameters

is	stream from which to read data to be filtered

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.

References inputStream::eof().

getPreviousInputStream()

inputStream & getPreviousInputStream ( )

virtual

Return a reference to the stream being filtered.

Returns

stream being filtered

Implements filteredInputStream.

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(), vmime::dynamicCast(), vmime::end(), dotFilteredInputStream::read(), and inputStream::read().

Referenced by dotFilteredInputStream::read().

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.

References inputStream::reset().

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.

---

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

• filteredStream.hpp
• filteredStream.cpp