UCommon
Public Member Functions
ucommon::charbuf Class Reference

A template to create a character array that can be manipulated as a string. More...

#include <string.h>

Public Member Functions

 charbuf ()
 Create a new character buffer with an empty string.
 charbuf (const char *text)
 Create a character buffer with assigned text.
 operator bool () const
 Test if data is contained in the object.
 operator char * ()
 Get text by casting reference.
bool operator! () const
 Test if the object is empty.
char * operator() (size_t offset)
 Get a pointer to an offset in the object by expression operator.
char * operator* ()
 Get text by object pointer reference.
void operator+= (const char *text)
 Concatenate text into the object.
void operator= (const char *text)
 Assign null terminated text to the object.
char operator[] (size_t offset) const
 Array operator to get a character from the object.
size_t size (void) const
 Get allocated size of the object.

Detailed Description

A template to create a character array that can be manipulated as a string.

This is a mini string/stringbuf class that supports a subset of functionality but does not require a complex supporting object. Like stringbuf, this can be used to create local string variables.

Author:
David Sugar <dyfet@gnutelephony.org>

Constructor & Destructor Documentation

ucommon::charbuf::charbuf ( const char *  text) [inline]

Create a character buffer with assigned text.

If the text is larger than the size of the object, it is truncated.

Parameters:
textto assign.

Definition at line 1507 of file string.h.


Member Function Documentation

ucommon::charbuf::operator bool ( ) const [inline]

Test if data is contained in the object.

Returns:
true if there is text.

Definition at line 1529 of file string.h.

ucommon::charbuf::operator char * ( ) [inline]

Get text by casting reference.

Returns:
pointer to text in object.

Definition at line 1543 of file string.h.

bool ucommon::charbuf::operator! ( ) const [inline]

Test if the object is empty.

Returns:
true if the object is empty.

Definition at line 1536 of file string.h.

char* ucommon::charbuf::operator() ( size_t  offset) [inline]

Get a pointer to an offset in the object by expression operator.

Parameters:
offsetof character in string buffer.
Returns:
pointer to offset in object.

Definition at line 1566 of file string.h.

char* ucommon::charbuf::operator* ( ) [inline]

Get text by object pointer reference.

Returns:
pointer to text in object.

Definition at line 1550 of file string.h.

void ucommon::charbuf::operator+= ( const char *  text) [inline]

Concatenate text into the object.

If the text is larger than the size of the object, then it is truncated.

Parameters:
textto append.

Definition at line 1522 of file string.h.

Here is the call graph for this function:

void ucommon::charbuf::operator= ( const char *  text) [inline]

Assign null terminated text to the object.

Parameters:
textto assign.

Definition at line 1514 of file string.h.

char ucommon::charbuf::operator[] ( size_t  offset) const [inline]

Array operator to get a character from the object.

Parameters:
offsetof character in string buffer.
Returns:
character at offset.

Definition at line 1558 of file string.h.

size_t ucommon::charbuf::size ( void  ) const [inline]

Get allocated size of the object.

Returns:
allocated size.

Definition at line 1573 of file string.h.


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