libpqxx 7.7.5
types.hxx
1/* Basic type aliases and forward declarations.
2 *
3 * Copyright (c) 2000-2023, Jeroen T. Vermeulen
4 *
5 * See COPYING for copyright license. If you did not receive a file called
6 * COPYING with this source code, please notify the distributor of this
7 * mistake, or contact the author.
8 */
9#ifndef PQXX_H_TYPES
10#define PQXX_H_TYPES
11
12#if !defined(PQXX_HEADER_PRE)
13# error "Include libpqxx headers as <pqxx/header>, not <pqxx/header.hxx>."
14#endif
15
16#include <cstddef>
17#include <cstdint>
18#include <iterator>
19
20#if defined(PQXX_HAVE_CONCEPTS) && __has_include(<ranges>)
21# include <ranges>
22#endif
23
24
25namespace pqxx
26{
28using result_size_type = int;
29
32
34using row_size_type = int;
35
38
40using field_size_type = std::size_t;
41
43using large_object_size_type = int64_t;
44
45
46// Forward declarations, to help break compilation dependencies.
47// These won't necessarily include all classes in libpqxx.
48class binarystring;
49class connection;
50class const_result_iterator;
51class const_reverse_result_iterator;
54class dbtransaction;
55class field;
58struct range_error;
59class result;
60class row;
61class stream_from;
63
65
68{};
69
71
74{};
75
76
78
80enum class format : int
81{
82 text = 0,
83 binary = 1,
84};
85
86
88
90template<typename TYPE>
91using strip_t = std::remove_cv_t<std::remove_reference_t<TYPE>>;
92
93
94#if defined(PQXX_HAVE_CONCEPTS)
96
99template<std::ranges::range CONTAINER>
101#else // PQXX_HAVE_CONCEPTS
103
106template<typename CONTAINER>
108#endif // PQXX_HAVE_CONCEPTS
109
110
111#if defined(PQXX_HAVE_CONCEPTS)
113template<typename STRING>
114concept char_string = std::ranges::contiguous_range<STRING> and
115 std::same_as < strip_t<value_type<STRING>>,
116char > ;
117
119template<typename RANGE>
120concept char_strings =
121 std::ranges::range<RANGE> and char_string<strip_t<value_type<RANGE>>>;
122
124template<typename DATA>
125concept potential_binary = std::ranges::contiguous_range<DATA> and
126 (sizeof(value_type<DATA>) == 1);
127#endif // PQXX_HAVE_CONCEPTS
128
129
130// C++20: Retire these compatibility definitions.
131#if defined(PQXX_HAVE_CONCEPTS)
132
134
137# define PQXX_RANGE_ARG std::ranges::range
138
140
143# define PQXX_CHAR_STRING_ARG pqxx::char_string
144
146
149# define PQXX_CHAR_STRINGS_ARG pqxx::char_strings
150
151#else // PQXX_HAVE_CONCEPTS
152
154
157# define PQXX_RANGE_ARG typename
158
160
163# define PQXX_CHAR_STRING_ARG typename
164
166
169# define PQXX_CHAR_STRINGS_ARG typename
170
171#endif // PQXX_HAVE_CONCEPTS
172} // namespace pqxx
173#endif
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:27
int row_size_type
Number of fields in a row of database data.
Definition: types.hxx:34
std::remove_cv_t< std::remove_reference_t< TYPE > > strip_t
Remove any constness, volatile, and reference-ness from a type.
Definition: types.hxx:91
int row_difference_type
Difference between row sizes.
Definition: types.hxx:37
std::size_t field_size_type
Number of bytes in a field of database data.
Definition: types.hxx:40
int result_difference_type
Difference between result sizes.
Definition: types.hxx:31
strip_t< decltype(*std::begin(std::declval< CONTAINER >()))> value_type
The type of a container's elements.
Definition: types.hxx:107
int result_size_type
Number of rows in a result set.
Definition: types.hxx:28
int64_t large_object_size_type
Number of bytes in a large object.
Definition: types.hxx:43
format
Format code: is data text or binary?
Definition: types.hxx:81
Binary data corresponding to PostgreSQL's "BYTEA" binary-string type.
Definition: binarystring.hxx:59
Connection to a database.
Definition: connection.hxx:185
Abstract transaction base class: bracket transactions on the database.
Definition: dbtransaction.hxx:54
Something is out of range, similar to std::out_of_range.
Definition: except.hxx:202
Reference to a field in a result set.
Definition: field.hxx:35
Accessor for large object's contents.
Definition: largeobject.hxx:154
Definition: notification.hxx:57
Result set containing data returned by a query or command.
Definition: result.hxx:74
Reference to one row in a result.
Definition: row.hxx:47
Iterator for fields in a row. Use as row::const_iterator.
Definition: row.hxx:287
Reverse iterator for a row. Use as row::const_reverse_iterator.
Definition: row.hxx:410
Stream data from the database.
Definition: stream_from.hxx:78
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:77
Marker for stream_from constructors: "stream from table.".
Definition: types.hxx:68
Marker for stream_from constructors: "stream from query.".
Definition: types.hxx:74