Puma::StringSource Class Reference

#include <Puma/StringSource.h>

Inheritance diagram for Puma::StringSource:

Description

String input source implementation implementing the Source interface.

Public Member Functions
	StringSource ()
	Construct an empty string input source. More...
	StringSource (const char *string)
	Construct an input source for the given string. More...
virtual int	read (char *dest, int n)
	Read n bytes from the input string into the given string. More...
void	string (const char *string)
	Set the input string to read from. More...
const char *	string ()
	Get the input string. More...
int	size ()
	Get the size of the input string. More...
Public Member Functions inherited from Puma::Source
	Source ()
	Constructs an empty source object. More...
virtual	~Source ()
	Destroys the source object. More...
virtual int	read (char *buffer, int n)=0
	Read n bytes from the source into the given string buffer. More...
virtual int	size ()
	Get the size of the source. More...

Constructor & Destructor Documentation

StringSource() [1/2]

Puma::StringSource::StringSource ( )

inline

Construct an empty string input source.

StringSource() [2/2]

Puma::StringSource::StringSource ( const char *  string )

inline

Construct an input source for the given string.

Parameters

string

The string from which to read.

Member Function Documentation

read()

virtual int Puma::StringSource::read ( char *  dest, int  n  )

inlinevirtual

Read n bytes from the input string into the given string.

Parameters

dest	The string used as buffer for the bytes read.
n	The number of bytes to read.

Returns

The number of bytes read, or -1 in case of errors.

Implements Puma::Source.

size()

int Puma::StringSource::size ( )

inlinevirtual

Get the size of the input string.

Returns

The size of the input string, or -1 if no input string set.

Reimplemented from Puma::Source.

string() [1/2]

const char * Puma::StringSource::string ( )

inline

Get the input string.

Returns

The input string, or null if no input string set.

string() [2/2]

void Puma::StringSource::string ( const char *  string )

inline

Set the input string to read from.

Parameters

string

The input string.