pqxx::const_row_iterator Class Reference

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

#include <row.hxx>

Inheritance diagram for pqxx::const_row_iterator:

Public Types
using	iterator_category = std::random_access_iterator_tag
using	value_type = field const
using	pointer = field const *
using	size_type = row_size_type
using	difference_type = row_difference_type
using	reference = field
Public Types inherited from pqxx::field
using	size_type = field_size_type

Public Member Functions
	const_row_iterator ()=default
	const_row_iterator (row const &t, row_size_type c) noexcept
	End a code block started by "ignore-deprecated-pre.hxx". More...
	const_row_iterator (field const &F) noexcept
	const_row_iterator (const_row_iterator const &)=default
	const_row_iterator (const_row_iterator &&)=default
Dereferencing operators
pointer	operator-> () const
reference	operator* () const
Manipulations
const_row_iterator &	operator= (const_row_iterator const &)=default
const_row_iterator &	operator= (const_row_iterator &&)=default
const_row_iterator	operator++ (int)
const_row_iterator &	operator++ ()
const_row_iterator	operator-- (int)
const_row_iterator &	operator-- ()
const_row_iterator &	operator+= (difference_type i)
const_row_iterator &	operator-= (difference_type i)
Comparisons
bool	operator== (const_row_iterator const &i) const
bool	operator!= (const_row_iterator const &i) const
bool	operator< (const_row_iterator const &i) const
bool	operator<= (const_row_iterator const &i) const
bool	operator> (const_row_iterator const &i) const
bool	operator>= (const_row_iterator const &i) const
Public Member Functions inherited from pqxx::field
	field (row const &r, row_size_type c) noexcept
	Constructor. Do not call this yourself; libpqxx will do it for you. More...
	field ()=default
	Constructor. Do not call this yourself; libpqxx will do it for you. More...
template<>
bool	to (char const *&obj) const
	Specialization: to(char const *&). More...
template<>
bool	to (zview &obj) const
template<>
bool	to (zview &obj, zview const &default_value) const
template<>
zview	as () const
template<>
zview	as (zview const &default_value) const
PQXX_PURE bool	operator== (field const &) const
	Byte-by-byte comparison of two fields (all nulls are considered equal) More...
PQXX_PURE bool	operator!= (field const &rhs) const
	Byte-by-byte comparison (all nulls are considered equal) More...
PQXX_PURE char const *	name () const &
	Column name. More...
oid PQXX_PURE	type () const
	Column type. More...
PQXX_PURE oid	table () const
	What table did this column come from? More...
PQXX_PURE row_size_type	num () const
	Return row number. The first row is row 0, the second is row 1, etc. More...
PQXX_PURE row_size_type	table_column () const
	What column number in its originating table did this column come from? More...
PQXX_PURE std::string_view	view () const &
	Read as string_view, or an empty one if null. More...
PQXX_PURE char const *	c_str () const &
	Read as plain C string. More...
PQXX_PURE bool	is_null () const noexcept
	Is this field's value null? More...
PQXX_PURE size_type	size () const noexcept
	Return number of bytes taken up by the field's value. More...
template<typename T >
auto	to (T &obj) const -> typename std::enable_if_t<(not std::is_pointer< T >::value or std::is_same< T, char const *>::value), bool >
	Read value into obj; or if null, leave obj untouched and return false. More...
template<typename... T>
bool	composite_to (T &...fields) const
	Read field as a composite value, write its components into fields. 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 >
auto	to (T &obj, T const &default_value) const -> typename std::enable_if_t<(not std::is_pointer< T >::value or std::is_same< T, char const *>::value), bool >
	Read value into obj; or if null, use default value and return false. More...
template<typename T >
T	as (T const &default_value) const
	Return value as object of given type, or default value if null. More...
template<typename T >
T	as () const
	Return value as object of given type, or throw exception if null. More...
template<typename T , template< typename > class O = std::optional>
constexpr O< T >	get () const
	Return value wrapped in some optional type (empty for nulls). More...
array_parser	as_array () const &
	Parse the field as an SQL array. More...

Arithmetic operators
const_row_iterator	operator+ (difference_type) const
const_row_iterator	operator- (difference_type) const
difference_type	operator- (const_row_iterator const &) const
const_row_iterator	operator+ (difference_type, const_row_iterator const &)

Additional Inherited Members
Protected Member Functions inherited from pqxx::field
result const &	home () const noexcept
result::size_type	idx () const noexcept
row_size_type	col () const noexcept
	field (result const &r, result_size_type row_num, row_size_type col_num)
Protected Attributes inherited from pqxx::field
row_size_type	m_col

Detailed Description

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

Member Typedef Documentation

difference_type

using pqxx::const_row_iterator::difference_type = row_difference_type

iterator_category

using pqxx::const_row_iterator::iterator_category = std::random_access_iterator_tag

pointer

using pqxx::const_row_iterator::pointer = field const *

reference

using pqxx::const_row_iterator::reference = field

size_type

using pqxx::const_row_iterator::size_type = row_size_type

value_type

using pqxx::const_row_iterator::value_type = field const

Constructor & Destructor Documentation

const_row_iterator() [1/5]

pqxx::const_row_iterator::const_row_iterator ( )

default

Start a block of deprecated code which may call other deprecated code.

Most compilers will emit warnings when deprecated code is invoked from non-deprecated code. But some compilers (notably gcc) will always emit the warning, even when the calling code is also deprecated.

This header starts a block where those warnings are suppressed. It can be included inside a code block.

Always match the #include with a closing #include of "ignore-deprecated-post.hxx". To avoid mistakes, keep the enclosed area as small as possible.

const_row_iterator() [2/5]

pqxx::const_row_iterator::const_row_iterator ( row const &  t, row_size_type  c  )

noexcept

End a code block started by "ignore-deprecated-pre.hxx".

const_row_iterator() [3/5]

pqxx::const_row_iterator::const_row_iterator ( field const &  F )

noexcept

const_row_iterator() [4/5]

pqxx::const_row_iterator::const_row_iterator ( const_row_iterator const &  )

default

const_row_iterator() [5/5]

pqxx::const_row_iterator::const_row_iterator ( const_row_iterator &&  )

default

Member Function Documentation

operator!=()

bool pqxx::const_row_iterator::operator!=

(

const_row_iterator const &

i

)

const

References pqxx::field::col().

operator*()

reference pqxx::const_row_iterator::operator*

(

)

const

operator+()

const_row_iterator pqxx::const_row_iterator::operator+

(

difference_type

o

)

const

References pqxx::field::col(), pqxx::result::columns(), pqxx::field::home(), and pqxx::field::idx().

operator++() [1/2]

pqxx::const_row_iterator pqxx::const_row_iterator::operator++

(

int

)

operator++() [2/2]

const_row_iterator& pqxx::const_row_iterator::operator++

(

)

operator+=()

const_row_iterator& pqxx::const_row_iterator::operator+=

(

difference_type

i

)

operator-() [1/2]

const_row_iterator pqxx::const_row_iterator::operator-

(

difference_type

o

)

const

References pqxx::field::col(), pqxx::result::columns(), pqxx::field::home(), and pqxx::field::idx().

operator-() [2/2]

const_row_iterator::difference_type pqxx::const_row_iterator::operator-

(

const_row_iterator const &

i

)

const

References pqxx::field::num().

operator--() [1/2]

pqxx::const_row_iterator pqxx::const_row_iterator::operator--

(

int

)

operator--() [2/2]

const_row_iterator& pqxx::const_row_iterator::operator--

(

)

operator-=()

const_row_iterator& pqxx::const_row_iterator::operator-=

(

difference_type

i

)

operator->()

pointer pqxx::const_row_iterator::operator->

(

)

const

operator<()

bool pqxx::const_row_iterator::operator<

(

const_row_iterator const &

i

)

const

References pqxx::field::col().

operator<=()

bool pqxx::const_row_iterator::operator<=

(

const_row_iterator const &

i

)

const

References pqxx::field::col().

operator=() [1/2]

const_row_iterator& pqxx::const_row_iterator::operator= ( const_row_iterator const &  )

default

operator=() [2/2]

const_row_iterator& pqxx::const_row_iterator::operator= ( const_row_iterator &&  )

default

operator==()

bool pqxx::const_row_iterator::operator==

(

const_row_iterator const &

i

)

const

References pqxx::field::col().

operator>()

bool pqxx::const_row_iterator::operator>

(

const_row_iterator const &

i

)

const

References pqxx::field::col().

operator>=()

bool pqxx::const_row_iterator::operator>=

(

const_row_iterator const &

i

)

const

References pqxx::field::col().

Friends And Related Function Documentation

operator+

const_row_iterator operator+ ( const_row_iterator::difference_type  o, const_row_iterator const &  i  )

friend

---

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

• row.hxx
• row.cxx