basic_static_string Class Template Reference
[String Library]

#include <stlsoft/string/static_string.hpp>

Inheritance diagram for basic_static_string:

Detailed Description

template<typename C, size_t CCH, typename T = char_traits<C>>
class stlsoft::basic_static_string< C, CCH, T >

Simple string class using fixed-size static-based storage.

Parameters:

	C	The character type
	CCH	The number of characters in the fixed-side buffer, not including the null-terminator
	T	The traits type. On translators that support default template arguments this is defaulted to char_traits<C>


Types
typedef C	value_type
	The value type.
typedef T	traits_type
	The traits type.
typedef allocator_selector< C > ::allocator_type	allocator_type
	The allocator type.
typedef basic_static_string< C, CCH, T >	class_type
	The current parameterisation of the type.
typedef value_type	char_type
	The character type.
typedef value_type *	pointer
	The pointer type.
typedef value_type const *	const_pointer
	The non-mutable (const) pointer type.
typedef value_type &	reference
	The reference type.
typedef value_type const &	const_reference
	The non-mutable (const) reference type.
typedef size_t	size_type
	The size type.
typedef ss_ptrdiff_t	difference_type
	The difference type.
typedef pointer_iterator < value_type, pointer, reference >::type	iterator
	The iterator type.
typedef pointer_iterator < value_type const , const_pointer, const_reference >::type	const_iterator
	The non-mutating (const) iterator type.
Attributes
size_type	size () const
	The number of elements in the string.
size_type	length () const
	The number of elements in the string.
size_type	capacity () const
	The storage currently allocated by the string.
bool	empty () const
	Indicates whether the string is empty.
static size_type	max_size ()
	The maximum number of elements that can be stored in the string.
Public Member Functions
Construction
	basic_static_string ()
	Default constructor.
	basic_static_string (class_type const &rhs)
	Copy constructor.
	basic_static_string (class_type const &s, size_type pos)
	Construct from the given string at the specified position.
	basic_static_string (class_type const &s, size_type pos, size_type n)
	Construct with `n` characters from the given string at the specified position.
	basic_static_string (char_type const *s)
	Construct from the given character string.
	basic_static_string (char_type const *s, size_type n)
	Construct with `n` characters from the given character string.
	basic_static_string (size_type n, char_type ch)
	Construct with `n` characters each set to `ch`.
	basic_static_string (char_type const f, char_type const t)
	Construct from the range [first:last).
	~basic_static_string () throw ()
	Destructor.
Assignment
class_type &	assign (char_type const *s)
	Assigns from the given character string.
class_type &	assign (char_type const *s, size_type n)
	Assigns with `n` characters from the given character string.
class_type &	assign (class_type const &str, size_type pos, size_type n)
	Assigns with `n` characters from the given character string at the specified position.
class_type &	assign (class_type const &str)
	Assigns from the given string.
class_type &	assign (size_type n, char_type c)
	Assigns `n` characters with the value `ch`.
class_type &	assign (const_iterator first, const_iterator last)
	Assigns from the range [first:last).
class_type const &	operator= (class_type const &rhs)
	Copy assignment operator.
class_type const &	operator= (char_type const *s)
	Assignment operator.
class_type const &	operator= (char_type ch)
	Assignment operator.
Appending
class_type &	append (char_type const *s)
	Appends the given character string.
class_type &	append (char_type const *s, size_type cch)
	Appends `cch` characters from the given character string.
class_type &	append (class_type const &str, size_type pos, size_type cch)
	Assigns `cch` characters from the given character string at the specified position.
class_type &	append (class_type const &str)
	Appends the given string.
class_type &	append (size_type cch, char_type ch)
	Appends `cch` characters with the value `ch`.
class_type &	append (const_iterator first, const_iterator last)
	Appends the range [first:last).
class_type &	operator+= (char_type ch)
	Concatenation operator.
class_type &	operator+= (char_type const *s)
	Concatenation operator.
class_type &	operator+= (class_type const &rhs)
	Concatenation operator.
void	push_back (char_type ch)
	Appends a single character.
void	pop_back ()
	Removes the last character.
Operations
void	reserve (size_type n)
	Reserves at least n characters.
void	swap (class_type &other)
	Swaps the contents between `this` and `other`.
void	resize (size_type n, value_type ch=value_type())
	Resizes the string.
void	clear ()
	Empties the string.
Comparison
ss_sint_t	compare (size_type pos, size_type n, value_type const *s, size_type cchRhs) const
	Compares `this` with the given string.
ss_sint_t	compare (size_type pos, size_type n, value_type const *s) const
	Compares `this` with the given string.
ss_sint_t	compare (value_type const *s) const
	Compares `this` with the given string.
ss_sint_t	compare (size_type pos, size_type n, class_type const &rhs, size_type posRhs, size_type cchRhs) const
	Compares `this` with the given string.
ss_sint_t	compare (size_type pos, size_type n, class_type const &rhs) const
	Compares `this` with the given string.
ss_sint_t	compare (class_type const &rhs) const
	Compares `this` with the given string.
Accessors
reference	operator[] (size_type index)
	Returns mutable reference at the given index.
const_reference	operator[] (size_type index) const
	Returns non-mutable (const) reference at the given index.
reference	at (size_type index)
	Returns mutable (non-const) reference at the given index.
const_reference	at (size_type index) const
	Returns non-mutable (const) reference at the given index.
value_type const *	c_str () const
	Returns null-terminated non-mutable (const) pointer to string data.
value_type const *	data () const
	Returns non-mutable (const) pointer to string data.
size_type	copy (value_type *dest, size_type cch_, size_type pos=0) const
	Copies elements into the given destination.
Iteration
const_iterator	begin () const
	Begins the iteration.
const_iterator	end () const
	Ends the iteration.
iterator	begin ()
	Begins the iteration.
iterator	end ()
	Ends the iteration.

Member Typedef Documentation

typedef C value_type

The value type.

typedef T traits_type

The traits type.

typedef allocator_selector<C>::allocator_type allocator_type

The allocator type.

typedef basic_static_string<C, CCH, T> class_type

The current parameterisation of the type.

typedef value_type char_type

The character type.

typedef value_type* pointer

The pointer type.

typedef value_type const* const_pointer

The non-mutable (const) pointer type.

typedef value_type& reference

The reference type.

typedef value_type const& const_reference

The non-mutable (const) reference type.

typedef size_t size_type

The size type.

typedef ss_ptrdiff_t difference_type

The difference type.

typedef pointer_iterator< value_type , pointer , reference >::type iterator

The iterator type.

typedef pointer_iterator< value_type const , const_pointer , const_reference >::type const_iterator

The non-mutating (const) iterator type.

Constructor & Destructor Documentation

basic_static_string ( )

Default constructor.

basic_static_string ( class_type const & rhs )

Copy constructor.

basic_static_string	(	class_type const &	s,
		size_type	pos
	)

Construct from the given string at the specified position.

basic_static_string	(	class_type const &	s,
		size_type	pos,
		size_type	n
	)

Construct with n characters from the given string at the specified position.

basic_static_string ( char_type const * s )

Construct from the given character string.

basic_static_string	(	char_type const *	s,
		size_type	n
	)

Construct with n characters from the given character string.

basic_static_string	(	size_type	n,
		char_type	ch
	)

Construct with n characters each set to ch.

basic_static_string	(	char_type const *	f,
		char_type const *	t
	)

Construct from the range [first:last).

~basic_static_string ( ) throw ()

Destructor.

Member Function Documentation

class_type& assign ( char_type const * s )

Assigns from the given character string.

class_type& assign	(	char_type const *	s,
		size_type	n
	)

Assigns with n characters from the given character string.

class_type& assign	(	class_type const &	str,
		size_type	pos,
		size_type	n
	)

Assigns with n characters from the given character string at the specified position.

class_type& assign ( class_type const & str )

Assigns from the given string.

class_type& assign	(	size_type	n,
		char_type	c
	)

Assigns n characters with the value ch.

class_type& assign	(	const_iterator	first,
		const_iterator	last
	)

Assigns from the range [first:last).

class_type const& operator= ( class_type const & rhs )

Copy assignment operator.

class_type const& operator= ( char_type const * s )

Assignment operator.

class_type const& operator= ( char_type ch )

Assignment operator.

class_type& append ( char_type const * s )

Appends the given character string.

class_type& append	(	char_type const *	s,
		size_type	cch
	)

Appends cch characters from the given character string.

class_type& append	(	class_type const &	str,
		size_type	pos,
		size_type	cch
	)

Assigns cch characters from the given character string at the specified position.

class_type& append ( class_type const & str )

Appends the given string.

class_type& append	(	size_type	cch,
		char_type	ch
	)

Appends cch characters with the value ch.

class_type& append	(	const_iterator	first,
		const_iterator	last
	)

Appends the range [first:last).

class_type& operator+= ( char_type ch )

Concatenation operator.

class_type& operator+= ( char_type const * s )

Concatenation operator.

class_type& operator+= ( class_type const & rhs )

Concatenation operator.

void push_back ( char_type ch )

Appends a single character.

void pop_back ( )

Removes the last character.

void reserve ( size_type n )

Reserves at least n characters.

void swap ( class_type & other )

Swaps the contents between this and other.

void resize	(	size_type	n,
		value_type	ch = `value_type()`
	)

Resizes the string.

Parameters:

	n	The new size of the string
	ch	The value with which to initialise additional items if the string is expanded

void clear ( )

Empties the string.

size_type size ( ) const

The number of elements in the string.

static size_type max_size ( ) [static]

The maximum number of elements that can be stored in the string.

size_type length ( ) const

The number of elements in the string.

size_type capacity ( ) const

The storage currently allocated by the string.

bool empty ( ) const

Indicates whether the string is empty.

ss_sint_t compare	(	size_type	pos,
		size_type	n,
		value_type const *	s,
		size_type	cchRhs
	)			const