---

more::gen::basic_gc_string Class Template Reference

A shallow copied garbage collected string to use for string literals. More...

#include <more/gen/gc_string.h>

Collaboration diagram for more::gen::basic_gc_string:

[legend]List of all members.

Public Types

• typedef Char char_type
• typedef std::size_t size_type
• typedef char_type const * iterator
• typedef char_type const * const_iterator

Public Methods

• basic_gc_string ()

  Construct an empty string. More...
  
  

• basic_gc_string (char_type const *c_str)

  Construct as a copy of c_str. More...
  
  

• basic_gc_string (char_type const *c_str, size_type n)

  Construct from persistent constant storage. More...
  
  

• basic_gc_string (basic_gc_string const &x)

  Construct a shallow copy of x. More...
  
  

• basic_gc_string & operator= (basic_gc_string const &x)

  Assign a shallow copy of x. More...
  
  

• char_type operator[] (size_type i) const

  Return the character an i. More...
  
  

• const_iterator begin () const
• const_iterator end () const
• size_type size () const
• size_type length () const
• bool empty () const
• basic_gc_string & append (char_type const *s, size_type n)
• basic_gc_string & append (char_type const *s)
• basic_gc_string & append (basic_gc_string const &str, size_type pos, size_type n)
• basic_gc_string & append (basic_gc_string const &str)
• basic_gc_string & append (size_type n, char_type ch)
• basic_gc_string & operator+= (char_type wc)
• basic_gc_string & operator+= (basic_gc_string const &rhs)
• basic_gc_string & operator+= (Char const *rhs)
• char_type const * c_str () const
• basic_gc_string substr (size_type i, size_type n=npos) const

Static Public Attributes

• const size_type npos = std::numeric_limits<size_type>::max()

Friends

• void swap (basic_gc_string &x, basic_gc_string &y)

---

Detailed Description

template<typename Char>
class more::gen::basic_gc_string< Char >

A shallow copied garbage collected string to use for string literals.

With a limited set of operations, the string behaves as if deep copied. (Actually, the operations which would break the deep-copy semantics, are excluded, at least for now.)

---

Member Typedef Documentation

template<typename Char> typedef Char more::gen::basic_gc_string::char_type

template<typename Char> typedef char_type const* more::gen::basic_gc_string::const_iterator

template<typename Char> typedef char_type const* more::gen::basic_gc_string::iterator

template<typename Char> typedef std::size_t more::gen::basic_gc_string::size_type

---

Constructor & Destructor Documentation

template<typename Char> more::gen::basic_gc_string< Char >::basic_gc_string (    )  [inline]

Construct an empty string.

template<typename Char> more::gen::basic_gc_string< Char >::basic_gc_string (  char_type const *    c_str )  [inline]

Construct as a copy of c_str.

template<typename Char> more::gen::basic_gc_string< Char >::basic_gc_string (  char_type const *    c_str, size_type    n )  [inline]

Construct from persistent constant storage. The lifetime of c_str must be longer than that of the constructed string. c_str is not explicitely allocated, so it may point to static or collected memory. c_str must be at least n characters.

template<typename Char> more::gen::basic_gc_string< Char >::basic_gc_string (  basic_gc_string< Char > const &    x )  [inline]

Construct a shallow copy of x.

---

Member Function Documentation

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::append (  size_type    n, char_type    ch )  [inline]

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::append (  basic_gc_string< Char > const &    str )  [inline]

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::append (  basic_gc_string< Char > const &    str, size_type    pos, size_type    n )  [inline]

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::append (  char_type const *    s )  [inline]

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::append (  char_type const *    s, size_type    n )  [inline]

template<typename Char> const_iterator more::gen::basic_gc_string< Char >::begin (    )  const [inline]

template<typename Char> char_type const* more::gen::basic_gc_string< Char >::c_str (    )  const [inline]

template<typename Char> bool more::gen::basic_gc_string< Char >::empty (    )  const [inline]

template<typename Char> const_iterator more::gen::basic_gc_string< Char >::end (    )  const [inline]

template<typename Char> size_type more::gen::basic_gc_string< Char >::length (    )  const [inline]

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::operator+= (  Char const *    rhs )  [inline]

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::operator+= (  basic_gc_string< Char > const &    rhs )  [inline]

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::operator+= (  char_type    wc )  [inline]

template<typename Char> basic_gc_string& more::gen::basic_gc_string< Char >::operator= (  basic_gc_string< Char > const &    x )  [inline]

Assign a shallow copy of x.

template<typename Char> char_type more::gen::basic_gc_string< Char >::operator[] (  size_type    i )  const [inline]

Return the character an i.

template<typename Char> size_type more::gen::basic_gc_string< Char >::size (    )  const [inline]

template<typename Char> basic_gc_string more::gen::basic_gc_string< Char >::substr (  size_type    i, size_type    n = npos )  const [inline]

---

Friends And Related Function Documentation

template<typename Char> void swap (  basic_gc_string< Char > &    x, basic_gc_string< Char > &    y )  [friend]

---

Member Data Documentation

template<typename Char> const size_type more::gen::basic_gc_string::npos = std::numeric_limits<size_type>::max() [static]

---

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

• more/gen/gc_string.h

---