pqxx::string_traits< char[N]> Struct Template Reference

String traits for C-style string constant ("pointer to array of char"). More...

Static Public Member Functions
static constexpr zview	to_buf (char *, char *, char const (&value)[N]) noexcept
static char *	into_buf (char *begin, char *end, char const (&value)[N])
static constexpr std::size_t	size_buffer (char const (&)[N]) noexcept
static void	from_string (std::string_view)=delete
	Don't allow conversion to this type.
static zview	to_buf (char *begin, char *end, char const &value)
	Return a string_view representing value, plus terminating zero.
static char *	into_buf (char *begin, char *end, char const &value)
	Write value's string representation into buffer at begin.
static char	from_string (std::string_view text)
	Parse a string representation of a TYPE value.
static std::size_t	size_buffer (char const &value) noexcept
	Estimate how much buffer space is needed to represent value.

Static Public Attributes
static constexpr bool	converts_to_string {true}
static constexpr bool	converts_from_string {false}
static constexpr bool	converts_to_string
	Is conversion from TYPE to strings supported?
static constexpr bool	converts_from_string
	Is conversion from string_view to TYPE supported?

Detailed Description

template<std::size_t N>
struct pqxx::string_traits< char[N]>

String traits for C-style string constant ("pointer to array of char").

Warning

This assumes that every array-of-char is a C-style string literal. So, it must include a trailing zero. and it must have static duration.

Member Function Documentation

from_string() [1/2]

static char pqxx::string_traits< char >::from_string ( std::string_view text )

inlinestaticnodiscard

Parse a string representation of a TYPE value.

Throws conversion_error if value does not meet the expected format for a value of this type.

Warning

A null value has no string representation. Do not parse a null.

from_string() [2/2]

template<std::size_t N>

static void pqxx::string_traits< char[N]>::from_string ( std::string_view )

staticdelete

Don't allow conversion to this type.

into_buf() [1/2]

static char * pqxx::string_traits< char >::into_buf ( char * begin, char * end, char const & value )

inlinestatic

Write value's string representation into buffer at begin.

into_buf() [2/2]

template<std::size_t N>

static char * pqxx::string_traits< char[N]>::into_buf ( char * begin, char * end, char const (&) value[N] )

inlinestatic

size_buffer() [1/2]

static std::size_t pqxx::string_traits< char >::size_buffer ( char const & value )

inlinestaticnodiscardnoexcept

Estimate how much buffer space is needed to represent value.

The estimate may be a little pessimistic, if it saves time.

The estimate includes the terminating zero.

size_buffer() [2/2]

template<std::size_t N>

static constexpr std::size_t pqxx::string_traits< char[N]>::size_buffer ( char const(&)[N] )

inlinestaticconstexprnoexcept

to_buf() [1/2]

template<std::size_t N>

static constexpr zview pqxx::string_traits< char[N]>::to_buf ( char * , char * , char const (&) value[N] )

inlinestaticconstexprnoexcept

to_buf() [2/2]

static zview pqxx::string_traits< char >::to_buf ( char * begin, char * end, char const & value )

inlinestaticnodiscard

Return a string_view representing value, plus terminating zero.

Produces a string_view containing the PostgreSQL string representation for value.

Warning

A null value has no string representation. Do not pass a null.

Uses the space from begin to end as a buffer, if needed. The returned string may lie somewhere in that buffer, or it may be a compile-time constant, or it may be null if value was a null value. Even if the string is stored in the buffer, its begin() may or may not be the same as begin.

The string_view is guaranteed to be valid as long as the buffer from begin to end remains accessible and unmodified.

Exceptions

pqxx::conversion_overrun

if the provided buffer space may not be enough. For maximum performance, this is a conservative estimate. It may complain about a buffer which is actually large enough for your value, if an exact check gets too expensive.

Member Data Documentation

converts_from_string [1/2]

template<std::size_t N>

bool pqxx::string_traits< char[N]>::converts_from_string {false}

staticconstexpr

converts_from_string [2/2]

bool pqxx::string_traits< char >::converts_from_string

staticconstexpr

Is conversion from string_view to TYPE supported?

When defining your own conversions, specialise this as true to indicate that your string traits support from_string.

converts_to_string [1/2]

template<std::size_t N>

bool pqxx::string_traits< char[N]>::converts_to_string {true}

staticconstexpr

converts_to_string [2/2]

bool pqxx::string_traits< char >::converts_to_string

staticconstexpr

Is conversion from TYPE to strings supported?

When defining your own conversions, specialise this as true to indicate that your string traits support the conversions to strings.

---

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

• /builddir/build/BUILD/libpqxx-7.10.5-build/libpqxx-7.10.5/redhat-linux-build/include/pqxx/internal/conversions.hxx