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 >
size_t ::type	c4::to_chars (substr buf, T v) noexcept
template<class T >
size_t	c4::to_chars (substr s, T *v) noexcept
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. More...
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
size_t	c4::to_chars (substr buf, const char *v) noexcept
template<class T >
size_t	c4::to_chars (substr buf, fmt::boolalpha_< T > fmt)
	write a variable as an alphabetic boolean, ie as either true or false More...
template<typename T >
std::enable_if< std::is_signed< T >::value, size_t >::type	c4::to_chars (substr buf, fmt::integral_< T > fmt)
	format an integer signed type More...
template<typename T >
std::enable_if< std::is_signed< T >::value, size_t >::type	c4::to_chars (substr buf, fmt::integral_padded_< T > fmt)
	format an integer signed type, pad with zeroes More...
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 More...
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)
size_t	c4::to_chars (substr buf, fmt::const_base64_wrapper b)
	write a variable in base64 format More...

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/27]

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

inlinenoexcept

Definition at line 2328 of file charconv.hpp.

{ return write_dec(buf, v); }

References c4::write_dec().

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

to_chars() [2/27]

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

inlinenoexcept

Definition at line 2329 of file charconv.hpp.

{ return write_dec(buf, v); }

References c4::write_dec().

to_chars() [3/27]

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

inlinenoexcept

Definition at line 2330 of file charconv.hpp.

{ return write_dec(buf, v); }

References c4::write_dec().

to_chars() [4/27]

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

inlinenoexcept

Definition at line 2331 of file charconv.hpp.

{ return write_dec(buf, v); }

References c4::write_dec().

to_chars() [5/27]

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

inlinenoexcept

Definition at line 2332 of file charconv.hpp.

{ return itoa(buf, v); }

References c4::itoa().

to_chars() [6/27]

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

inlinenoexcept

Definition at line 2333 of file charconv.hpp.

{ return itoa(buf, v); }

References c4::itoa().

to_chars() [7/27]

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

inlinenoexcept

Definition at line 2334 of file charconv.hpp.

{ return itoa(buf, v); }

References c4::itoa().

to_chars() [8/27]

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

inlinenoexcept

Definition at line 2335 of file charconv.hpp.

{ return itoa(buf, v); }

References c4::itoa().

to_chars() [9/27]

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

inlinenoexcept

Definition at line 2336 of file charconv.hpp.

{ return ftoa(buf, v); }

References c4::ftoa().

to_chars() [10/27]

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

inlinenoexcept

Definition at line 2337 of file charconv.hpp.

{ return dtoa(buf, v); }

References c4::dtoa().

to_chars() [11/27]

template<class T >

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

noexcept

Definition at line 2339 of file charconv.hpp.

{ return itoa(buf, v); }

to_chars() [12/27]

template<class T >

size_t c4::to_chars ( substr  s, T *  v  )

inlinenoexcept

Definition at line 2342 of file charconv.hpp.

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

References c4::itoa().

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 2427 of file charconv.hpp.

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

References c4::to_chars().

to_chars() [13/27]

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

inlinenoexcept

Definition at line 2439 of file charconv.hpp.

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

References c4::to_chars().

to_chars() [14/27]

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

inlinenoexcept

Definition at line 2504 of file charconv.hpp.

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

to_chars() [15/27]

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

inlinenoexcept

Definition at line 2541 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/27]

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

inlinenoexcept

Definition at line 2579 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() [17/27]

template<size_t N>

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

inlinenoexcept

Definition at line 2644 of file charconv.hpp.

{
    csubstr sp(v);
    return to_chars(buf, sp);
}

References c4::to_chars().

to_chars() [18/27]

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

inlinenoexcept

Definition at line 2651 of file charconv.hpp.

{
    return to_chars(buf, to_csubstr(v));
}

References c4::to_csubstr().

Referenced by c4::to_chars(), and c4::to_chars_sub().

to_chars() [19/27]

template<class T >

size_t c4::to_chars ( substr  buf, fmt::boolalpha_< T >  fmt  )

inline

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

Definition at line 87 of file format.hpp.

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

References c4::to_chars(), and c4::fmt::boolalpha_< T >::val.

to_chars() [20/27]

template<typename T >

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

inline

format an integer signed type

Definition at line 293 of file format.hpp.

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

References c4::itoa(), c4::fmt::integral_< T >::radix, and c4::fmt::integral_< T >::val.

to_chars() [21/27]

template<typename T >

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

inline

format an integer signed type, pad with zeroes

Definition at line 302 of file format.hpp.

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

References c4::itoa(), c4::fmt::integral_padded_< T >::num_digits, c4::fmt::integral_padded_< T >::radix, and c4::fmt::integral_padded_< T >::val.

to_chars() [22/27]

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

inline

Definition at line 372 of file format.hpp.

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

References c4::fmt::real_< T >::fmt, c4::ftoa(), c4::fmt::real_< T >::precision, and c4::fmt::real_< T >::val.

to_chars() [23/27]

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

inline

Definition at line 374 of file format.hpp.

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

References c4::dtoa(), c4::fmt::real_< T >::fmt, c4::fmt::real_< T >::precision, and c4::fmt::real_< T >::val.

to_chars() [24/27]

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

write a variable in raw binary format, using memcpy

to_chars() [25/27]

template<class T >

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

Definition at line 536 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.pad);
    to_chars(buf, align.val);
    return align.width;
}

References c4::fmt::left_< T >::pad, c4::to_chars(), c4::fmt::left_< T >::val, and c4::fmt::left_< T >::width.

to_chars() [26/27]

template<class T >

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

Definition at line 548 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 = static_cast<size_t>(align.width - ret);
    buf.first(rem).fill(align.pad);
    to_chars(buf.sub(rem), align.val);
    return align.width;
}

References c4::fmt::right_< T >::pad, c4::to_chars(), c4::fmt::right_< T >::val, and c4::fmt::right_< T >::width.

to_chars() [27/27]

size_t c4::to_chars ( substr  buf, fmt::const_base64_wrapper  b  )

inline

write a variable in base64 format

Definition at line 127 of file base64.hpp.

{
    return base64_encode(buf, b.data);
}

References c4::base64_encode(), and c4::fmt::base64_wrapper_< CharOrConstChar >::data.