pqxx::binarystring Class Reference

#include <binarystring.hxx>

Inheritance diagram for pqxx::binarystring:

Inheritance graph
[legend]

List of all members.

Public Types

typedef content_type char_type
typedef std::char_traits
< char_type >::char_type 
value_type
typedef size_t size_type
typedef long difference_type
typedef const value_typeconst_reference
typedef const value_typeconst_pointer
typedef const_pointer const_iterator

Public Member Functions

 binarystring (const result::field &F)
 Read and unescape bytea field.
size_type size () const throw ()
 Size of converted string in bytes.
size_type length () const throw ()
 Size of converted string in bytes.
bool empty () const throw ()
const_iterator begin () const throw ()
const_iterator end () const throw ()
const_reference front () const throw ()
const_reference back () const throw ()
const value_typedata () const throw ()
 Unescaped field contents.
const_reference operator[] (size_type i) const throw ()
bool operator== (const binarystring &) const throw ()
bool operator!= (const binarystring &rhs) const throw ()
const_reference at (size_type) const
 Index contained string, checking for valid index.
void swap (binarystring &)
 Swap contents with other binarystring.
const char * get () const throw ()
 Raw character buffer (no terminating zero is added).
std::string str () const
 Read as regular C++ string (may include null characters).

Package Attributes

 __pad0__:PQAlloc<value_type> super

Related Functions

(Note that these are not member functions.)

std::string escape_binary (const std::string &bin)
 Escape binary string for inclusion in SQL.
std::string escape_binary (const char bin[])
 Escape binary string for inclusion in SQL.
std::string escape_binary (const char bin[], size_t len)
 Escape binary string for inclusion in SQL.
std::string escape_binary (const unsigned char bin[])
 Escape binary string for inclusion in SQL.
std::string escape_binary (const unsigned char bin[], size_t len)
 Escape binary string for inclusion in SQL.


Member Typedef Documentation

typedef std ::char_traits<char_type>::char_type pqxx::binarystring::value_type


Constructor & Destructor Documentation

pqxx::binarystring::binarystring ( const result::field F  )  [explicit]

Read and unescape bytea field.

The field will be zero-terminated, even if the original bytea field isn't.

Parameters:
F the field to read; must be a bytea field

References pqxx::result::field::c_str(), and pqxx::result::field::size().


Member Function Documentation

size_type pqxx::binarystring::size (  )  const throw ()

Size of converted string in bytes.

Referenced by operator==().

size_type pqxx::binarystring::length (  )  const throw ()

Size of converted string in bytes.

bool pqxx::binarystring::empty (  )  const throw ()

const_iterator pqxx::binarystring::begin (  )  const throw ()

const_iterator pqxx::binarystring::end (  )  const throw ()

const_reference pqxx::binarystring::front (  )  const throw ()

const_reference pqxx::binarystring::back (  )  const throw ()

const value_type* pqxx::binarystring::data (  )  const throw ()

Unescaped field contents.

Referenced by at(), and operator==().

const_reference pqxx::binarystring::operator[] ( size_type  i  )  const throw ()

bool pqxx::binarystring::operator== ( const binarystring rhs  )  const throw ()

References data(), and size().

bool pqxx::binarystring::operator!= ( const binarystring rhs  )  const throw ()

pqxx::binarystring::const_reference pqxx::binarystring::at ( size_type  n  )  const

Index contained string, checking for valid index.

References data(), and pqxx::to_string().

void pqxx::binarystring::swap ( binarystring rhs  ) 

Swap contents with other binarystring.

References m_size.

const char* pqxx::binarystring::get (  )  const throw ()

Raw character buffer (no terminating zero is added).

Warning:
No terminating zero is added! If the binary data did not end in a null character, you will not find one here.

Reimplemented from pqxx::internal::PQAlloc< T, DELETER >.

string pqxx::binarystring::str (  )  const

Read as regular C++ string (may include null characters).

Warning:
libpqxx releases before 3.1 stored the string and returned a reference to it. This is no longer the case! It now creates and returns a new string object. Avoid repeated use of this function; retrieve your string once and keep it in a local variable. Also, do not expect to be able to compare the string's address to that of an earlier invocation.


Member Data Documentation


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

Generated on Mon Feb 15 18:22:49 2010 for libpqxx by  doxygen 1.5.5