to_chars: generalized chars to value

Convert the given value, writing into the string. More...

Functions
size_t	c4::to_chars (substr buf, uint8_t v) noexcept
size_t	c4::to_chars (substr buf, uint16_t v) noexcept
size_t	c4::to_chars (substr buf, uint32_t v) noexcept
size_t	c4::to_chars (substr buf, uint64_t v) noexcept
size_t	c4::to_chars (substr buf, int8_t v) noexcept
size_t	c4::to_chars (substr buf, int16_t v) noexcept
size_t	c4::to_chars (substr buf, int32_t v) noexcept
size_t	c4::to_chars (substr buf, int64_t v) noexcept
size_t	c4::to_chars (substr buf, float v) noexcept
size_t	c4::to_chars (substr buf, double v) noexcept
template<class T>
auto	c4::to_chars (substr buf, T v) noexcept -> size_t::type
template<class T>
auto	c4::to_chars (substr s, T *v) noexcept -> typename std::enable_if<!std::is_same< T, char >::value &&!std::is_same< T, const char >::value, size_t >::type
template<class T>
substr	c4::to_chars_sub (substr buf, T const &v) noexcept
	call to_chars() and return a substr consisting of the written portion of the input buffer.
size_t	c4::to_chars (substr buf, bool v) noexcept
size_t	c4::to_chars (substr buf, char v) noexcept
size_t	c4::to_chars (substr buf, csubstr v) noexcept
size_t	c4::to_chars (substr buf, substr v) noexcept
template<size_t N>
size_t	c4::to_chars (substr buf, const char(&v)[N]) noexcept
	(1) overload for char(&)[N] and const char(&)[N]
template<class CharPtr>
auto	c4::to_chars (substr buf, CharPtr v) noexcept -> typename std::enable_if< std::is_same< CharPtr, char * >::value||std::is_same< CharPtr, const char * >::value, size_t >::type
	(2) overload for char* and const char*.
size_t	c4::to_chars (substr, std::nullptr_t) noexcept
size_t	c4::to_chars (substr buf, fmt::boolalpha_ fmt)
	write a variable as an alphabetic boolean, ie as either true or false
template<typename T>
auto	c4::to_chars (substr buf, fmt::integral_< T > fmt) -> typename std::enable_if< std::is_signed< T >::value, size_t >::type
	format an integer signed type
template<typename T>
auto	c4::to_chars (substr buf, fmt::integral_padded_< T > fmt) -> typename std::enable_if< std::is_signed< T >::value, size_t >::type
	format an integer signed type, pad with zeroes
template<typename T>
auto	c4::to_chars (substr buf, fmt::integral_< T > fmt) -> typename std::enable_if< std::is_unsigned< T >::value, size_t >::type
	format an integer unsigned type
template<typename T>
auto	c4::to_chars (substr buf, fmt::integral_padded_< T > fmt) -> typename std::enable_if< std::is_unsigned< T >::value, size_t >::type
	format an integer unsigned type, pad with zeroes
size_t	c4::to_chars (substr buf, fmt::real_< float > fmt)
size_t	c4::to_chars (substr buf, fmt::real_< double > fmt)
size_t	c4::to_chars (substr buf, fmt::const_raw_wrapper r)
	write a variable in raw binary format, using memcpy
template<class T>
size_t	c4::to_chars (substr buf, fmt::left_< T > const &align)
template<class T>
size_t	c4::to_chars (substr buf, fmt::right_< T > const &align)
template<class T>
size_t	c4::to_chars (substr buf, fmt::center_< T > const &align)
template<typename CharOrConstChar>
size_t	c4::to_chars (substr buf, fmt::detail::base64_wrapper_< CharOrConstChar > const &b)
	write a variable or buffer in base64 format
template<class Container, typename CharOrConstChar>
size_t	c4::to_chars (substr buf, fmt::detail::base64_container_wrapper_< Container, CharOrConstChar > const &b)
	write a container in base64 format

Detailed Description

Convert the given value, writing into the string.

The resulting string will NOT be null-terminated. Return the number of characters needed. This function is safe to call when the string is too small - no writes will occur beyond the string's last character.

Dispatches to the most appropriate and efficient conversion function.

See also

write_dec, utoa: unsigned to chars, itoa: signed to chars, ftoa: float32 to chars, dtoa: float64 to chars

Warning

When serializing floating point values (float or double), be aware that because it uses defaults, to_chars() may cause a truncation of the precision. To enforce a particular precision, use for example c4::fmt::real, or call directly c4::ftoa or c4::dtoa.

Function Documentation

to_chars() [1/32]

size_t c4::to_chars ( substr buf, uint8_t v )

inlinenoexcept

Definition at line 2342 of file charconv.hpp.

{ return write_dec(buf, v); }

Referenced by cat(), catsep(), format(), to_chars(), to_chars(), to_chars(), and to_chars().

to_chars() [2/32]

size_t c4::to_chars ( substr buf, uint16_t v )

inlinenoexcept

Definition at line 2343 of file charconv.hpp.

{ return write_dec(buf, v); }

to_chars() [3/32]

size_t c4::to_chars ( substr buf, uint32_t v )

inlinenoexcept

Definition at line 2344 of file charconv.hpp.

{ return write_dec(buf, v); }

to_chars() [4/32]

size_t c4::to_chars ( substr buf, uint64_t v )

inlinenoexcept

Definition at line 2345 of file charconv.hpp.

{ return write_dec(buf, v); }

to_chars() [5/32]

size_t c4::to_chars ( substr buf, int8_t v )

inlinenoexcept

Definition at line 2346 of file charconv.hpp.

{ return itoa(buf, v); }

to_chars() [6/32]

size_t c4::to_chars ( substr buf, int16_t v )

inlinenoexcept

Definition at line 2347 of file charconv.hpp.

{ return itoa(buf, v); }

to_chars() [7/32]

size_t c4::to_chars ( substr buf, int32_t v )

inlinenoexcept

Definition at line 2348 of file charconv.hpp.

{ return itoa(buf, v); }

to_chars() [8/32]

size_t c4::to_chars ( substr buf, int64_t v )

inlinenoexcept

Definition at line 2349 of file charconv.hpp.

{ return itoa(buf, v); }

to_chars() [9/32]

size_t c4::to_chars ( substr buf, float v )

inlinenoexcept

Definition at line 2350 of file charconv.hpp.

{ return ftoa(buf, v); }

to_chars() [10/32]

size_t c4::to_chars ( substr buf, double v )

inlinenoexcept

Definition at line 2351 of file charconv.hpp.

{ return dtoa(buf, v); }

to_chars() [11/32]

template<class T>

auto c4::to_chars ( substr buf, T v )->size_t::type

inlinenoexcept

Definition at line 2353 of file charconv.hpp.

{ return itoa(buf, v); }

to_chars() [12/32]

template<class T>

auto c4::to_chars ( substr s, T * v )->typenamestd::enable_if<!std::is_same< T, char >::value &&!std::is_same< T, constchar >::value, size_t >::type

inlinenoexcept

Definition at line 2356 of file charconv.hpp.

{
    return itoa(s, (intptr_t)v, (intptr_t)16);
}

to_chars_sub()

template<class T>

substr c4::to_chars_sub ( substr buf, T const & v )

inlinenoexcept

call to_chars() and return a substr consisting of the written portion of the input buffer.

Ie, same as to_chars(), but return a substr instead of a size_t. Convert the given value to a string using to_chars(), and return the resulting string, up to and including the last written character.

See also

to_chars()

Definition at line 2447 of file charconv.hpp.

{
    size_t sz = to_chars(buf, v);
    return buf.left_of(sz <= buf.len ? sz : buf.len);
}

Referenced by to_chars_sub().

to_chars() [13/32]

size_t c4::to_chars ( substr buf, bool v )

inlinenoexcept

Definition at line 2459 of file charconv.hpp.

{
    int val = v;
    return to_chars(buf, val);
}

to_chars() [14/32]

size_t c4::to_chars ( substr buf, char v )

inlinenoexcept

Definition at line 2523 of file charconv.hpp.

{
    if(buf.len > 0)
    {
        C4_XASSERT(buf.str);
        buf.str[0] = v;
    }
    return 1;
}

to_chars() [15/32]

size_t c4::to_chars ( substr buf, csubstr v )

inlinenoexcept

Definition at line 2560 of file charconv.hpp.

{
    C4_ASSERT(!buf.overlaps(v));
    size_t len = buf.len < v.len ? buf.len : v.len;
    // calling memcpy with null strings is undefined behavior
    // and will wreak havoc in calling code's branches.
    // see https://github.com/biojppm/rapidyaml/pull/264#issuecomment-1262133637
    if(len)
    {
        C4_ASSERT(buf.str != nullptr);
        C4_ASSERT(v.str != nullptr);
        memcpy(buf.str, v.str, len);
    }
    return v.len;
}

to_chars() [16/32]

size_t c4::to_chars ( substr buf, substr v )

inlinenoexcept

Definition at line 2598 of file charconv.hpp.

{
    C4_ASSERT(!buf.overlaps(v));
    size_t len = buf.len < v.len ? buf.len : v.len;
    // calling memcpy zero len is undefined behavior
    // and will wreak havoc in calling code's branches.
    // see https://github.com/biojppm/rapidyaml/pull/264#issuecomment-1262133637
    if(len)
    {
        C4_ASSERT(buf.str != nullptr);
        C4_ASSERT(v.str != nullptr);
        memcpy(buf.str, v.str, len);
    }
    return v.len;
}

to_chars() [17/32]

template<size_t N>

size_t c4::to_chars ( substr buf, const char(&) v[N] )

noexcept

(1) overload for char(&)[N] and const char(&)[N]

Definition at line 2664 of file charconv.hpp.

{
    return to_chars(buf, csubstr{v, N-1});
}

to_chars() [18/32]

template<class CharPtr>

auto c4::to_chars ( substr buf, CharPtr v )->typenamestd::enable_if< std::is_same< CharPtr, char * >::value||std::is_same< CharPtr, constchar * >::value, size_t >::type

noexcept

(2) overload for char* and const char*.

Must be zero-terminated!

Warning

will call strlen()

Note

this overload uses SFINAE to prevent it from overriding the array overload

See also

For a more detailed explanation on why the plain pointer overloads cannot coexist with the array overloads, see http://cplusplus.bordoon.com/specializeForCharacterArrays.html

Definition at line 2676 of file charconv.hpp.

{
    return v ? to_chars(buf, csubstr{v, strlen(v)}) : 0;
}

to_chars() [19/32]

size_t c4::to_chars ( substr , std::nullptr_t  )

inlinenoexcept

Definition at line 2689 of file charconv.hpp.

{
    return 0;
}

to_chars() [20/32]

size_t c4::to_chars ( substr buf, fmt::boolalpha_ fmt )

inline

write a variable as an alphabetic boolean, ie as either true or false

Definition at line 84 of file format.hpp.

{
    return to_chars(buf, fmt.val ? "true" : "false");
}

to_chars() [21/32]

template<typename T>

auto c4::to_chars ( substr buf, fmt::integral_< T > fmt )->typenamestd::enable_if< std::is_signed< T >::value, size_t >::type

inline

format an integer signed type

Definition at line 288 of file format.hpp.

{
    return itoa(buf, fmt.val, fmt.radix);
}

to_chars() [22/32]

template<typename T>

auto c4::to_chars ( substr buf, fmt::integral_padded_< T > fmt )->typenamestd::enable_if< std::is_signed< T >::value, size_t >::type

inline

format an integer signed type, pad with zeroes

Definition at line 296 of file format.hpp.

{
    return itoa(buf, fmt.val, fmt.radix, fmt.num_digits);
}

to_chars() [23/32]

template<typename T>

auto c4::to_chars ( substr buf, fmt::integral_< T > fmt )->typenamestd::enable_if< std::is_unsigned< T >::value, size_t >::type

inline

format an integer unsigned type

Definition at line 305 of file format.hpp.

{
    return utoa(buf, fmt.val, fmt.radix);
}

to_chars() [24/32]

template<typename T>

auto c4::to_chars ( substr buf, fmt::integral_padded_< T > fmt )->typenamestd::enable_if< std::is_unsigned< T >::value, size_t >::type

inline

format an integer unsigned type, pad with zeroes

Definition at line 313 of file format.hpp.

{
    return utoa(buf, fmt.val, fmt.radix, fmt.num_digits);
}

to_chars() [25/32]

size_t c4::to_chars ( substr buf, fmt::real_< float > fmt )

inline

Definition at line 374 of file format.hpp.

{ return ftoa(buf, fmt.val, fmt.precision, fmt.fmt); }

to_chars() [26/32]

size_t c4::to_chars ( substr buf, fmt::real_< double > fmt )

inline

Definition at line 376 of file format.hpp.

{ return dtoa(buf, fmt.val, fmt.precision, fmt.fmt); }

to_chars() [27/32]

size_t c4::to_chars	(	substr	buf,
		fmt::const_raw_wrapper	r )

write a variable in raw binary format, using memcpy

Definition at line 18 of file format.cpp.

{
    void * vptr = buf.str;
    size_t space = buf.len;
    char * ptr = (char*) std::align(r.alignment, r.len, vptr, space);
    if(ptr == nullptr)
    {
        // if it was not possible to align, return a conservative estimate
        // of the required space
        return r.alignment + r.len;
    }
    C4_CHECK(ptr >= buf.begin() && ptr <= buf.end());
    size_t sz = static_cast<size_t>(ptr - buf.str) + r.len;
    if(sz <= buf.len)
    {
        memcpy(ptr, r.buf, r.len);
    }
    return sz;
}

to_chars() [28/32]

template<class T>

size_t c4::to_chars	(	substr	buf,
		fmt::left_< T > const &	align )

Definition at line 567 of file format.hpp.

{
    size_t ret = to_chars(buf, align.val);
    if(ret >= buf.len || ret >= align.width)
        return ret > align.width ? ret : align.width;
    buf.first(align.width).sub(ret).fill(align.padchar);
    return align.width;
}

to_chars() [29/32]

template<class T>

size_t c4::to_chars	(	substr	buf,
		fmt::right_< T > const &	align )

Definition at line 578 of file format.hpp.

{
    size_t ret = to_chars(buf, align.val);
    if(ret >= buf.len || ret >= align.width)
        return ret > align.width ? ret : align.width;
    size_t rem = align.width - ret;
    if(ret)
        memmove(buf.str + rem, buf.str, ret);
    buf.first(rem).fill(align.padchar);
    return align.width;
}

to_chars() [30/32]

template<class T>

size_t c4::to_chars	(	substr	buf,
		fmt::center_< T > const &	align )

Definition at line 592 of file format.hpp.

{
    size_t ret = to_chars(buf, align.val);
    if(ret >= buf.len || ret >= align.width)
        return ret > align.width ? ret : align.width;
    size_t first = (align.width - ret) / 2u;
    if(ret)
        memmove(buf.str + first, buf.str, ret);
    buf.first(first).fill(align.padchar);
    buf.sub(first + ret).fill(align.padchar);
    return align.width;
}

to_chars() [31/32]

template<typename CharOrConstChar>

size_t c4::to_chars ( substr buf, fmt::detail::base64_wrapper_< CharOrConstChar > const & b )

inline

write a variable or buffer in base64 format

Definition at line 238 of file format_base64.hpp.

{
    size_t reqsize = base64_encode(buf.str, buf.len, b.data.buf, b.data.len);
    if(b.required_size)
        *b.required_size = reqsize;
    return reqsize;
}

to_chars() [32/32]

template<class Container, typename CharOrConstChar>

size_t c4::to_chars	(	substr	buf,
		fmt::detail::base64_container_wrapper_< Container, CharOrConstChar > const &	b )

write a container in base64 format

Definition at line 248 of file format_base64.hpp.

{
    cblob data = b.data();
    size_t reqsize = base64_encode(buf.str, buf.len, data.buf, data.len);
    if(b.required_size)
        *b.required_size = reqsize;
    return reqsize;
}