pqxx::string_traits< char * > Struct Reference

String traits for non-const C-style string ("pointer to char"). More...

Static Public Member Functions
static char *	into_buf (char *begin, char *end, char *const &value)
static zview	to_buf (char *begin, char *end, char *const &value)
static std::size_t	size_buffer (char *const &value) noexcept
static char *	from_string (std::string_view)=delete
	Don't allow conversion to this type since it breaks const-safety.
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

String traits for non-const C-style string ("pointer to char").

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]

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

staticdelete

Don't allow conversion to this type since it breaks const-safety.

into_buf() [1/2]

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

inlinestatic

into_buf() [2/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.

size_buffer() [1/2]

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

inlinestaticnoexcept

size_buffer() [2/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.

to_buf() [1/2]

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

inlinestatic

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]

bool pqxx::string_traits< char * >::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]

bool pqxx::string_traits< char * >::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