11#ifndef PQXX_H_BINARYSTRING
12#define PQXX_H_BINARYSTRING
18#include "pqxx/result.hxx"
19#include "pqxx/strconv.hxx"
24template<>
struct string_traits<binarystring>;
58 using value_type = std::char_traits<char_type>::char_type;
74 [[deprecated(
"Use std::byte for binary data.")]]
explicit binarystring(
81 [[deprecated(
"Use std::byte for binary data.")]]
explicit binarystring(
85 [[deprecated(
"Use std::byte for binary data.")]]
binarystring(
86 void const *, std::size_t);
90 std::shared_ptr<value_type> ptr,
size_type size) :
91 m_buf{std::move(ptr)}, m_size{size}
98 [[nodiscard]]
bool empty() const noexcept {
return size() == 0; }
108 return *(data() + m_size - 1);
130 [[nodiscard]] PQXX_PURE
bool operator==(
binarystring const &)
const noexcept;
133 return not operator==(rhs);
148 [[nodiscard]]
char const *
get() const noexcept
150 return reinterpret_cast<char const *
>(m_buf.get());
154 [[nodiscard]] std::string_view
view() const noexcept
156 return std::string_view(get(), size());
165 [[nodiscard]] std::string str()
const;
168 [[nodiscard]] std::byte
const *
bytes()
const
170 return reinterpret_cast<std::byte
const *
>(get());
174 [[nodiscard]] std::basic_string_view<std::byte>
bytes_view()
const
176 return std::basic_string_view<std::byte>{bytes(), size()};
180 std::shared_ptr<value_type> m_buf;
214 "Not enough buffer space to escape binary data."};
215 std::string_view
text{value.
view()};
217 return begin + budget;
223 std::shared_ptr<unsigned char> buf{
224 new unsigned char[size], [](
unsigned char const *x) {
delete[] x; }};
226#include "pqxx/internal/ignore-deprecated-pre.hxx"
228#include "pqxx/internal/ignore-deprecated-post.hxx"
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:23
std::basic_string_view< std::byte > binary_cast(TYPE const &data)
Cast binary data to a type that libpqxx will recognise as binary.
Definition: util.hxx:289
zview generic_to_buf(char *begin, char *end, TYPE const &value)
Implement string_traits<TYPE>::to_buf by calling into_buf.
Definition: strconv.hxx:439
void unesc_bin(std::string_view escaped_data, std::byte buffer[])
Reconstitute binary data from its escaped version.
Definition: util.cxx:179
void esc_bin(std::basic_string_view< std::byte > binary_data, char buffer[]) noexcept
Hex-escape binary data into a buffer.
Definition: util.cxx:148
constexpr std::size_t size_esc_bin(std::size_t binary_bytes) noexcept
Compute buffer size needed to escape binary data for use as a BYTEA.
Definition: util.hxx:397
constexpr bool cmp_less(LEFT lhs, RIGHT rhs)
C++20 std::cmp_less, or workaround if not available.
Definition: util.hxx:53
constexpr std::size_t size_unesc_bin(std::size_t escaped_bytes) noexcept
Compute binary size from the size of its escaped version.
Definition: util.hxx:406
Binary data corresponding to PostgreSQL's "BYTEA" binary-string type.
Definition: binarystring.hxx:55
const_reverse_iterator crend() const
Definition: binarystring.hxx:120
char const * get() const noexcept
Raw character buffer (no terminating zero is added).
Definition: binarystring.hxx:148
const_reverse_iterator rbegin() const
Definition: binarystring.hxx:111
bool operator!=(binarystring const &rhs) const noexcept
Definition: binarystring.hxx:131
const_pointer const_iterator
Definition: binarystring.hxx:63
const_iterator end() const noexcept
Definition: binarystring.hxx:102
std::basic_string_view< std::byte > bytes_view() const
Read data as a std::basic_string_view<std::byte>.
Definition: binarystring.hxx:174
const_iterator begin() const noexcept
Definition: binarystring.hxx:100
std::char_traits< char_type >::char_type value_type
Definition: binarystring.hxx:58
value_type const & const_reference
Definition: binarystring.hxx:61
long difference_type
Definition: binarystring.hxx:60
binarystring(std::shared_ptr< value_type > ptr, size_type size)
Efficiently wrap a buffer of binary data in a binarystring.
Definition: binarystring.hxx:89
const_reverse_iterator crbegin() const
Definition: binarystring.hxx:115
std::size_t size_type
Definition: binarystring.hxx:59
const_reference front() const noexcept
Definition: binarystring.hxx:105
const_reference back() const noexcept
Definition: binarystring.hxx:106
std::string_view view() const noexcept
Read contents as a std::string_view.
Definition: binarystring.hxx:154
bool empty() const noexcept
Definition: binarystring.hxx:98
std::byte const * bytes() const
Access data as a pointer to std::byte.
Definition: binarystring.hxx:168
const_reference operator[](size_type i) const noexcept
Definition: binarystring.hxx:125
const_iterator cend() const noexcept
Definition: binarystring.hxx:103
value_type const * data() const noexcept
Unescaped field contents.
Definition: binarystring.hxx:123
const_reverse_iterator rend() const
Definition: binarystring.hxx:116
size_type length() const noexcept
Size of converted string in bytes.
Definition: binarystring.hxx:97
binarystring & operator=(binarystring const &)
unsigned char char_type
Definition: binarystring.hxx:57
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition: binarystring.hxx:64
const_iterator cbegin() const noexcept
Definition: binarystring.hxx:101
binarystring(binarystring const &)=default
value_type const * const_pointer
Definition: binarystring.hxx:62
size_type size() const noexcept
Size of converted string in bytes.
Definition: binarystring.hxx:95
static char * into_buf(char *begin, char *end, binarystring const &value)
Definition: binarystring.hxx:209
static std::size_t size_buffer(binarystring const &value) noexcept
Definition: binarystring.hxx:199
static zview to_buf(char *begin, char *end, binarystring const &value)
Definition: binarystring.hxx:204
static binarystring from_string(std::string_view text)
Definition: binarystring.hxx:220
Could not convert value to string: not enough buffer space.
Definition: except.hxx:183
Reference to a field in a result set.
Definition: field.hxx:31
Traits describing a type's "null value," if any.
Definition: strconv.hxx:89
Nullness traits describing a type which does not have a null value.
Definition: strconv.hxx:111
Traits class for use in string conversions.
Definition: strconv.hxx:153
static std::size_t size_buffer(TYPE const &value) noexcept
Estimate how much buffer space is needed to represent value.
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:38