inputStream Class Reference

Inheritance diagram for inputStream:

Collaboration diagram for inputStream:

List of all members.

Public Member Functions
virtual bool	eof () const =0
virtual void	reset ()=0
virtual size_type	read (value_type *const data, const size_type count)=0
virtual size_type	skip (const size_type count)=0
Public Member Functions inherited from stream
virtual	~stream ()
virtual size_type	getBlockSize ()

Additional Inherited Members
Public Types inherited from stream
typedef string::value_type	value_type
typedef string::size_type	size_type
Static Public Attributes inherited from stream
static const size_type	npos = static_cast <size_type>(vmime::string::npos)

---

Detailed Description

Simple input stream.

---

Member Function Documentation

virtual bool eof ( ) const

pure virtual

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

Returns:

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

Implemented in stopSequenceFilteredInputStream< COUNT >, dotFilteredInputStream, inputStreamSocketAdapter, seekableInputStreamRegionAdapter, parserInputStreamAdapter, inputStreamStringProxyAdapter, inputStreamAdapter, inputStreamStringAdapter, and inputStreamByteBufferAdapter.

Referenced by IMAPFolder::addMessage(), vmime::utility::bufferedStreamCopy(), vmime::utility::bufferedStreamCopyRange(), charsetConverter_iconv::convert(), uuEncoder::decode(), qpEncoder::decode(), b64Encoder::decode(), b64Encoder::encode(), uuEncoder::encode(), qpEncoder::encode(), and dotFilteredInputStream::eof().

virtual size_type read ( value_type *const  data, const size_type  count  )

pure 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

Implemented in stopSequenceFilteredInputStream< COUNT >, stopSequenceFilteredInputStream< COUNT >, stopSequenceFilteredInputStream< COUNT >, dotFilteredInputStream, inputStreamSocketAdapter, seekableInputStreamRegionAdapter, parserInputStreamAdapter, inputStreamStringProxyAdapter, inputStreamAdapter, inputStreamStringAdapter, and inputStreamByteBufferAdapter.

Referenced by IMAPFolder::addMessage(), vmime::utility::bufferedStreamCopy(), vmime::utility::bufferedStreamCopyRange(), charsetConverter_iconv::convert(), uuEncoder::decode(), qpEncoder::decode(), b64Encoder::decode(), b64Encoder::encode(), uuEncoder::encode(), qpEncoder::encode(), and dotFilteredInputStream::read().

virtual void reset ( )

pure virtual

Set the read pointer to the beginning of the stream.

Warning:

WARNING: this may not work for all stream types.

Implemented in stopSequenceFilteredInputStream< COUNT >, dotFilteredInputStream, inputStreamSocketAdapter, seekableInputStreamRegionAdapter, parserInputStreamAdapter, inputStreamStringProxyAdapter, inputStreamAdapter, inputStreamStringAdapter, and inputStreamByteBufferAdapter.

Referenced by b64Encoder::decode(), defaultEncoder::decode(), qpEncoder::decode(), uuEncoder::decode(), qpEncoder::encode(), b64Encoder::encode(), uuEncoder::encode(), defaultEncoder::encode(), dotFilteredInputStream::reset(), and stopSequenceFilteredInputStream< COUNT >::reset().

virtual size_type skip ( const size_type  count )

pure virtual

Skip a number of bytes.

Parameters:

count

maximum number of bytes to ignore

Returns:

number of bytes skipped

Implemented in stopSequenceFilteredInputStream< COUNT >, dotFilteredInputStream, parserInputStreamAdapter, inputStreamSocketAdapter, seekableInputStreamRegionAdapter, inputStreamStringProxyAdapter, inputStreamAdapter, inputStreamStringAdapter, and inputStreamByteBufferAdapter.

Referenced by vmime::utility::bufferedStreamCopyRange().

---

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

• inputStream.hpp