Write a value

Writes a value without checking the buffer length decimal number – but asserting. More...

Functions
template<class T>
size_t	c4::write_dec (substr buf, T v) noexcept
	write an integer to a string in decimal format.
template<class T>
size_t	c4::write_hex (substr buf, T v) noexcept
	write an integer to a string in hexadecimal format.
template<class T>
size_t	c4::write_oct (substr buf, T v) noexcept
	write an integer to a string in octal format.
template<class T>
size_t	c4::write_bin (substr buf, T v) noexcept
	write an integer to a string in binary format.
template<class T>
size_t	c4::write_dec (substr buf, T val, size_t num_digits) noexcept
	same as c4::write_dec(), but pad with zeroes on the left such that the resulting string is num_digits wide.
template<class T>
size_t	c4::write_hex (substr buf, T val, size_t num_digits) noexcept
	same as c4::write_hex(), but pad with zeroes on the left such that the resulting string is num_digits wide.
template<class T>
size_t	c4::write_bin (substr buf, T val, size_t num_digits) noexcept
	same as c4::write_bin(), but pad with zeroes on the left such that the resulting string is num_digits wide.
template<class T>
size_t	c4::write_oct (substr buf, T val, size_t num_digits) noexcept
	same as c4::write_oct(), but pad with zeroes on the left such that the resulting string is num_digits wide.

Detailed Description

Writes a value without checking the buffer length decimal number – but asserting.

Function Documentation

write_dec() [1/2]

template<class T>

size_t c4::write_dec ( substr buf, T v )

inlinenoexcept

write an integer to a string in decimal format.

This is the lowest level (and the fastest) function to do this task.

Note

does not accept negative numbers

the resulting string is NOT zero-terminated.

it is ok to call this with an empty or too-small buffer; no writes will occur, and the required size will be returned

Returns

the number of characters required for the buffer.

Definition at line 714 of file charconv.hpp.

{
    C4_STATIC_ASSERT(std::is_integral<T>::value);
    C4_ASSERT(v >= 0);
    unsigned digits = digits_dec(v);
    if C4_LIKELY(buf.len >= digits)
        write_dec_unchecked(buf, v, digits);
    return digits;
}

Referenced by itoa(), itoa(), to_chars(), to_chars(), to_chars(), to_chars(), utoa(), utoa(), xtoa(), xtoa(), xtoa(), and xtoa().

write_hex() [1/2]

template<class T>

size_t c4::write_hex ( substr buf, T v )

inlinenoexcept

write an integer to a string in hexadecimal format.

This is the lowest level (and the fastest) function to do this task.

Note

does not accept negative numbers

does not prefix with 0x

the resulting string is NOT zero-terminated.

it is ok to call this with an empty or too-small buffer; no writes will occur, and the required size will be returned

Returns

the number of characters required for the buffer.

Definition at line 733 of file charconv.hpp.

{
    C4_STATIC_ASSERT(std::is_integral<T>::value);
    C4_ASSERT(v >= 0);
    unsigned digits = digits_hex(v);
    if C4_LIKELY(buf.len >= digits)
        write_hex_unchecked(buf, v, digits);
    return digits;
}

Referenced by itoa(), and utoa().

write_oct() [1/2]

template<class T>

size_t c4::write_oct ( substr buf, T v )

inlinenoexcept

write an integer to a string in octal format.

This is the lowest level (and the fastest) function to do this task.

Note

does not accept negative numbers

does not prefix with 0o

the resulting string is NOT zero-terminated.

it is ok to call this with an empty or too-small buffer; no writes will occur, and the required size will be returned

Returns

the number of characters required for the buffer.

Definition at line 752 of file charconv.hpp.

{
    C4_STATIC_ASSERT(std::is_integral<T>::value);
    C4_ASSERT(v >= 0);
    unsigned digits = digits_oct(v);
    if C4_LIKELY(buf.len >= digits)
        write_oct_unchecked(buf, v, digits);
    return digits;
}

Referenced by itoa(), and utoa().

write_bin() [1/2]

template<class T>

size_t c4::write_bin ( substr buf, T v )

inlinenoexcept

write an integer to a string in binary format.

This is the lowest level (and the fastest) function to do this task.

Note

does not accept negative numbers

does not prefix with 0b

the resulting string is NOT zero-terminated.

it is ok to call this with an empty or too-small buffer; no writes will occur, and the required size will be returned

Returns

the number of characters required for the buffer.

Definition at line 771 of file charconv.hpp.

{
    C4_STATIC_ASSERT(std::is_integral<T>::value);
    C4_ASSERT(v >= 0);
    unsigned digits = digits_bin(v);
    C4_ASSERT(digits > 0);
    if C4_LIKELY(buf.len >= digits)
        write_bin_unchecked(buf, v, digits);
    return digits;
}

Referenced by itoa(), and utoa().

write_dec() [2/2]

template<class T>

size_t c4::write_dec ( substr buf, T val, size_t num_digits )

inlinenoexcept

same as c4::write_dec(), but pad with zeroes on the left such that the resulting string is num_digits wide.

If the given number requires more than num_digits, then the number prevails.

Definition at line 812 of file charconv.hpp.

{
    return detail::write_num_digits<T, &write_dec<T>>(buf, val, num_digits);
}

write_hex() [2/2]

template<class T>

size_t c4::write_hex ( substr buf, T val, size_t num_digits )

inlinenoexcept

same as c4::write_hex(), but pad with zeroes on the left such that the resulting string is num_digits wide.

If the given number requires more than num_digits, then the number prevails.

Definition at line 821 of file charconv.hpp.

{
    return detail::write_num_digits<T, &write_hex<T>>(buf, val, num_digits);
}

write_bin() [2/2]

template<class T>

size_t c4::write_bin ( substr buf, T val, size_t num_digits )

inlinenoexcept

same as c4::write_bin(), but pad with zeroes on the left such that the resulting string is num_digits wide.

If the given number requires more than num_digits, then the number prevails.

Definition at line 830 of file charconv.hpp.

{
    return detail::write_num_digits<T, &write_bin<T>>(buf, val, num_digits);
}

write_oct() [2/2]

template<class T>

size_t c4::write_oct ( substr buf, T val, size_t num_digits )

inlinenoexcept

same as c4::write_oct(), but pad with zeroes on the left such that the resulting string is num_digits wide.

If the given number requires more than num_digits, then the number prevails.

Definition at line 839 of file charconv.hpp.

{
    return detail::write_num_digits<T, &write_oct<T>>(buf, val, num_digits);
}