inputStreamStringAdapter Class Reference

Inheritance diagram for inputStreamStringAdapter:

Collaboration diagram for inputStreamStringAdapter:

List of all members.

Public Member Functions
	inputStreamStringAdapter (const string &buffer)
	inputStreamStringAdapter (const string &buffer, const string::size_type begin, const string::size_type end)
bool	eof () const
void	reset ()
size_type	read (value_type *const data, const size_type count)
size_type	skip (const size_type count)
size_type	getPosition () const
void	seek (const size_type pos)

---

Detailed Description

An adapter class for string input.

---

Constructor & Destructor Documentation

inputStreamStringAdapter

(

const string &

buffer

)

inputStreamStringAdapter	(	const string &	buffer,
		const string::size_type	begin,
		const string::size_type	end
	)

---

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.

stream::size_type 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.

stream::size_type read ( value_type *const  data, const size_type  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().

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_type  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.

stream::size_type skip ( const size_type  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:

• inputStreamStringAdapter.hpp
• inputStreamStringAdapter.cpp