libpqxx  v4.0-1
C++ library for PostgreSQL
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pqxx::const_tuple_iterator Class Reference

Iterator for fields in a tuple. Use as tuple::const_iterator. More...

#include <tuple.hxx>

Inheritance diagram for pqxx::const_tuple_iterator:
Collaboration diagram for pqxx::const_tuple_iterator:

Public Types

typedef tuple::difference_type difference_type
 
typedef field reference
 
typedef tuple::size_type size_type
 

Public Member Functions

 const_tuple_iterator (const tuple &T, tuple::size_type C) throw ()
 
 const_tuple_iterator (const field &F) throw ()
 
template<>
bool to (const char *&Obj) const
 Specialization: to(const char *&). More...
 
Dereferencing operators
pointer operator-> () const
 
reference operator* () const
 
Manipulations
const_tuple_iterator operator++ (int)
 
const_tuple_iteratoroperator++ ()
 
const_tuple_iterator operator-- (int)
 
const_tuple_iteratoroperator-- ()
 
const_tuple_iteratoroperator+= (difference_type i)
 
const_tuple_iteratoroperator-= (difference_type i)
 
Comparisons
bool operator== (const const_tuple_iterator &i) const
 
bool operator!= (const const_tuple_iterator &i) const
 
bool operator< (const const_tuple_iterator &i) const
 
bool operator<= (const const_tuple_iterator &i) const
 
bool operator> (const const_tuple_iterator &i) const
 
bool operator>= (const const_tuple_iterator &i) const
 
Comparison
bool operator== (const field &) const
 Byte-by-byte comparison of two fields (all nulls are considered equal) More...
 
bool operator!= (const field &rhs) const
 Byte-by-byte comparison (all nulls are considered equal) More...
 
Column information
const char * name () const
 Column name. More...
 
oid type () const
 Column type. More...
 
oid table () const
 What table did this column come from? More...
 
tuple_size_type num () const
 
tuple_size_type table_column () const
 What column number in its originating table did this column come from? More...
 
Content access
const char * c_str () const
 Read as plain C string. More...
 
template<typename T >
bool to (T &Obj) const
 Read value into Obj; or leave Obj untouched and return false if null. More...
 
template<typename T >
bool to (T &Obj, const T &Default) const
 Read value into Obj; or use Default & return false if null. More...
 
template<typename T >
bool operator>> (T &Obj) const
 Read value into Obj; or leave Obj untouched and return false if null. More...
 
template<typename T >
as (const T &Default) const
 Return value as object of given type, or Default if null. More...
 
template<typename T >
as () const
 Return value as object of given type, or throw exception if null. More...
 
bool is_null () const throw ()
 
size_type size () const throw ()
 

Protected Member Functions

tuple_size_type col () const throw ()
 
const resulthome () const throw ()
 
size_t idx () const throw ()
 

Protected Attributes

tuple_size_type m_col
 

Private Types

typedef PGSTD::iterator
< PGSTD::random_access_iterator_tag,
const field, tuple::size_type
it
 

Arithmetic operators

const_tuple_iterator operator+ (difference_type) const
 
const_tuple_iterator operator- (difference_type) const
 
difference_type operator- (const_tuple_iterator) const
 
const_tuple_iterator operator+ (difference_type, const_tuple_iterator)
 

Detailed Description

Iterator for fields in a tuple. Use as tuple::const_iterator.

Member Typedef Documentation

typedef PGSTD::iterator<PGSTD::random_access_iterator_tag, const field, tuple::size_type> pqxx::const_tuple_iterator::it
private

Constructor & Destructor Documentation

pqxx::const_tuple_iterator::const_tuple_iterator ( const tuple T,
tuple::size_type  C 
) throw ()
inline
pqxx::const_tuple_iterator::const_tuple_iterator ( const field F) throw ()
inline

Member Function Documentation

template<typename T >
T pqxx::field::as ( const T &  Default) const
inlineinherited

Return value as object of given type, or Default if null.

Note that unless the function is instantiated with an explicit template argument, the Default value's type also determines the result type.

template<typename T >
T pqxx::field::as ( ) const
inlineinherited

Return value as object of given type, or throw exception if null.

const char* pqxx::field::c_str ( ) const
inherited

Read as plain C string.

Since the field's data is stored internally in the form of a zero-terminated C string, this is the fastest way to read it. Use the to() or as() functions to convert the string to other types such as int, or to C++ strings.

Referenced by pqxx::from_string(), pqxx::field_streambuf< CHAR, TRAITS >::initialize(), pqxx::operator<<(), and pqxx::to_string().

Here is the caller graph for this function:

tuple_size_type pqxx::field::col ( ) const throw ()
inlineprotectedinherited
const result* pqxx::field::home ( ) const throw ()
inlineprotectedinherited
size_t pqxx::field::idx ( ) const throw ()
inlineprotectedinherited
bool pqxx::field::is_null ( ) const throw ()
inherited
const char* pqxx::field::name ( ) const
inherited

Column name.

tuple_size_type pqxx::field::num ( ) const
inlineinherited

Referenced by operator-().

Here is the caller graph for this function:

bool pqxx::field::operator!= ( const field rhs) const
inlineinherited

Byte-by-byte comparison (all nulls are considered equal)

Warning
See operator==() for important information about this operator
bool pqxx::const_tuple_iterator::operator!= ( const const_tuple_iterator i) const
inline
reference pqxx::const_tuple_iterator::operator* ( ) const
inline
const_tuple_iterator pqxx::const_tuple_iterator::operator+ ( difference_type  o) const
inline
const_tuple_iterator pqxx::const_tuple_iterator::operator++ ( int  )
const_tuple_iterator& pqxx::const_tuple_iterator::operator++ ( )
inline
const_tuple_iterator& pqxx::const_tuple_iterator::operator+= ( difference_type  i)
inline
const_tuple_iterator pqxx::const_tuple_iterator::operator- ( difference_type  o) const
inline
const_tuple_iterator::difference_type pqxx::const_tuple_iterator::operator- ( const_tuple_iterator  i) const
inline

References pqxx::field::num().

Here is the call graph for this function:

const_tuple_iterator pqxx::const_tuple_iterator::operator-- ( int  )
const_tuple_iterator& pqxx::const_tuple_iterator::operator-- ( )
inline
const_tuple_iterator& pqxx::const_tuple_iterator::operator-= ( difference_type  i)
inline
pointer pqxx::const_tuple_iterator::operator-> ( ) const
inline
bool pqxx::const_tuple_iterator::operator< ( const const_tuple_iterator i) const
inline
bool pqxx::const_tuple_iterator::operator<= ( const const_tuple_iterator i) const
inline
bool pqxx::field::operator== ( const field ) const
inherited

Byte-by-byte comparison of two fields (all nulls are considered equal)

Warning
null handling is still open to discussion and change!

Handling of null values differs from that in SQL where a comparison involving a null value yields null, so nulls are never considered equal to one another or even to themselves.

Null handling also probably differs from the closest equivalent in C++, which is the NaN (Not-a-Number) value, a singularity comparable to SQL's null. This is because the builtin == operator demands that a == a.

The usefulness of this operator is questionable. No interpretation whatsoever is imposed on the data; 0 and 0.0 are considered different, as are null vs. the empty string, or even different (but possibly equivalent and equally valid) encodings of the same Unicode character etc.

bool pqxx::const_tuple_iterator::operator== ( const const_tuple_iterator i) const
inline
bool pqxx::const_tuple_iterator::operator> ( const const_tuple_iterator i) const
inline
bool pqxx::const_tuple_iterator::operator>= ( const const_tuple_iterator i) const
inline
template<typename T >
bool pqxx::field::operator>> ( T &  Obj) const
inlineinherited

Read value into Obj; or leave Obj untouched and return false if null.

size_type pqxx::field::size ( ) const throw ()
inherited

Referenced by pqxx::from_string(), pqxx::field_streambuf< CHAR, TRAITS >::initialize(), pqxx::operator<<(), and pqxx::to_string().

Here is the caller graph for this function:

oid pqxx::field::table ( ) const
inherited

What table did this column come from?

tuple_size_type pqxx::field::table_column ( ) const
inherited

What column number in its originating table did this column come from?

template<typename T >
bool pqxx::field::to ( T &  Obj) const
inlineinherited

Read value into Obj; or leave Obj untouched and return false if null.

References pqxx::from_string().

Here is the call graph for this function:

template<typename T >
bool pqxx::field::to ( T &  Obj,
const T &  Default 
) const
inlineinherited

Read value into Obj; or use Default & return false if null.

template<>
bool pqxx::field::to ( const char *&  Obj) const
inlineinherited

Specialization: to(const char *&).

The buffer has the same lifetime as the data in this result (i.e. of this result object, or the last remaining one copied from it etc.), so take care not to use it after the last result object referring to this query result is destroyed.

oid pqxx::field::type ( ) const
inherited

Column type.

Friends And Related Function Documentation

Member Data Documentation

tuple_size_type pqxx::field::m_col
protectedinherited

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