irc::sepstream Class Reference

#include <hashcomp.h>

Inheritance diagram for irc::sepstream:

Public Member Functions
	sepstream (const std::string &source, char seperator)
virtual	~sepstream ()
virtual bool	GetToken (std::string &token)
virtual const std::string	GetRemaining ()
virtual bool	StreamEnd ()

Detailed Description

irc::sepstream allows for splitting token seperated lists. Each successive call to sepstream::GetToken() returns the next token, until none remain, at which point the method returns an empty string.

Constructor & Destructor Documentation

sepstream()

irc::sepstream::sepstream	(	const std::string &	source,
		char	seperator
	)

Create a sepstream and fill it with the provided data

~sepstream()

irc::sepstream::~sepstream ( )

virtual

Destructor

Member Function Documentation

GetRemaining()

const std::string irc::sepstream::GetRemaining ( )

virtual

Fetch the entire remaining stream, without tokenizing

Returns

The remaining part of the stream

GetToken()

bool irc::sepstream::GetToken ( std::string &  token )

virtual

Fetch the next token from the stream

Parameters

token

The next token from the stream is placed here

Returns

True if tokens still remain, false if there are none left

StreamEnd()

bool irc::sepstream::StreamEnd ( )

virtual

Returns true if the end of the stream has been reached

Returns

True if the end of the stream has been reached, otherwise false

---

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

• include/hashcomp.h
• src/hashcomp.cpp