11 #ifndef PQXX_H_BINARYSTRING 12 #define PQXX_H_BINARYSTRING 14 #include "pqxx/compiler-public.hxx" 15 #include "pqxx/internal/compiler-internal-pre.hxx" 19 #include <string_view> 21 #include "pqxx/result.hxx" 22 #include "pqxx/strconv.hxx" 27 template<>
struct string_traits<binarystring>;
60 using value_type = std::char_traits<char_type>::char_type;
88 m_buf{std::move(ptr)}, m_size{size}
95 [[nodiscard]]
bool empty() const noexcept {
return size() == 0; }
105 return *(data() + m_size - 1);
127 [[nodiscard]] PQXX_PURE
bool operator==(
binarystring const &)
const noexcept;
130 return not operator==(rhs);
145 [[nodiscard]]
char const *
get()
const noexcept
147 return reinterpret_cast<char const *
>(m_buf.get());
151 [[nodiscard]] std::string_view
view() const noexcept
153 return std::string_view(
get(), size());
162 [[nodiscard]] std::string str()
const;
165 std::shared_ptr<value_type> m_buf;
185 static std::size_t
size_buffer(binarystring
const &value) noexcept
190 static zview to_buf(
char *begin,
char *end, binarystring
const &value)
192 auto const value_end{into_buf(begin, end, value)};
193 return zview{begin, value_end - begin - 1};
196 static char *
into_buf(
char *begin,
char *end, binarystring
const &value)
199 if (static_cast<std::size_t>(end - begin) < budget)
201 "Not enough buffer space to escape binary data."};
203 return begin + budget;
209 std::shared_ptr<unsigned char> buf{
210 new unsigned char[size], [](
unsigned char const *x) {
delete[] x; }};
212 return binarystring{std::move(buf), size};
217 #include "pqxx/internal/compiler-internal-post.hxx" value_type const * data() const noexcept
Unescaped field contents.
Definition: binarystring.hxx:120
const_iterator end() const noexcept
Definition: binarystring.hxx:99
Traits class for use in string conversions.
Definition: strconv.hxx:126
const_iterator begin() const noexcept
Definition: binarystring.hxx:97
const_reference operator[](size_type i) const noexcept
Definition: binarystring.hxx:122
void esc_bin(std::string_view binary_data, char buffer[]) noexcept
Hex-escape binary data into a buffer.
Definition: util.cxx:123
static char * into_buf(char *begin, char *end, binarystring const &value)
Definition: binarystring.hxx:196
const_reverse_iterator rbegin() const
Definition: binarystring.hxx:108
const_iterator cend() const noexcept
Definition: binarystring.hxx:100
std::size_t size_type
Definition: binarystring.hxx:61
std::reverse_iterator< const_iterator > const_reverse_iterator
Definition: binarystring.hxx:66
Binary data corresponding to PostgreSQL's "BYTEA" binary-string type.
Definition: binarystring.hxx:56
const_reference front() const noexcept
Definition: binarystring.hxx:102
static std::size_t size_buffer(binarystring const &value) noexcept
Definition: binarystring.hxx:185
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:25
static binarystring from_string(std::string_view text)
Definition: binarystring.hxx:206
Reference to a field in a result set.
Definition: field.hxx:33
const_reverse_iterator crend() const
Definition: binarystring.hxx:117
binarystring(std::shared_ptr< value_type > ptr, size_type size)
Efficiently wrap a buffer of binary data in a binarystring.
Definition: binarystring.hxx:87
size_type size() const noexcept
Size of converted string in bytes.
Definition: binarystring.hxx:92
std::char_traits< char_type >::char_type value_type
Definition: binarystring.hxx:60
const_reference back() const noexcept
Definition: binarystring.hxx:103
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:36
std::string_view view() const noexcept
Read contents as a std::string_view.
Definition: binarystring.hxx:151
long difference_type
Definition: binarystring.hxx:62
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:307
unsigned char char_type
Definition: binarystring.hxx:59
Could not convert value to string: not enough buffer space.
Definition: except.hxx:185
const_reverse_iterator crbegin() const
Definition: binarystring.hxx:112
value_type const * const_pointer
Definition: binarystring.hxx:64
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:298
std::size_t size_buffer(TYPE const &value) noexcept
Estimate how much buffer space is needed to represent value as a string.
Definition: strconv.hxx:321
const_reverse_iterator rend() const
Definition: binarystring.hxx:113
const_pointer const_iterator
Definition: binarystring.hxx:65
size_type length() const noexcept
Size of converted string in bytes.
Definition: binarystring.hxx:94
const_iterator cbegin() const noexcept
Definition: binarystring.hxx:98
Nullness traits describing a type which does not have a null value.
Definition: strconv.hxx:108
bool empty() const noexcept
Definition: binarystring.hxx:95
void unesc_bin(std::string_view escaped_data, std::byte buffer[])
Reconstitute binary data from its escaped version.
Definition: util.cxx:153
bool operator!=(binarystring const &rhs) const noexcept
Definition: binarystring.hxx:128
static zview to_buf(char *begin, char *end, binarystring const &value)
Definition: binarystring.hxx:190
Traits describing a type's "null value," if any.
Definition: strconv.hxx:86
value_type const & const_reference
Definition: binarystring.hxx:63