c4::yml::WriterBuf Struct Reference

A writer to a memory buffer, in the form of a substr . More...

#include <writer_buf.hpp>

Public Member Functions
	WriterBuf (substr sp) noexcept
substr	get_result (bool error_on_excess) const
	Return the buffer written so far, or optionally throw an error if the buffer was too small.
template<size_t N>
void	append (const char(&a)[N]) noexcept
void	append (csubstr s) noexcept
void	append (const char c) noexcept
void	append (const char c, size_t num_times) noexcept

Public Attributes
substr	m_buf
size_t	m_pos

Detailed Description

A writer to a memory buffer, in the form of a substr .

No overflow occurs; the buffer size is strictly respected.

Definition at line 20 of file writer_buf.hpp.

Constructor & Destructor Documentation

WriterBuf()

c4::yml::WriterBuf::WriterBuf ( substr sp )

inlinenoexcept

Definition at line 25 of file writer_buf.hpp.

: m_buf(sp), m_pos(0) {}

Member Function Documentation

get_result()

substr c4::yml::WriterBuf::get_result ( bool error_on_excess ) const

inline

Return the buffer written so far, or optionally throw an error if the buffer was too small.

Definition at line 31 of file writer_buf.hpp.

    {
        if(m_pos <= m_buf.len)
        {
            return m_buf.first(m_pos);
        }
        else if(!error_on_excess)
        {
            substr sp;
            sp.str = nullptr;
            sp.len = m_pos;
            return sp;
        }
        else
        {
            RYML_ERR_BASIC_("not enough space in the given buffer");
        }
    }

Referenced by c4::yml::emit_json(), c4::yml::emit_json(), c4::yml::emit_json(), c4::yml::emit_yaml(), c4::yml::emit_yaml(), and c4::yml::emit_yaml().

append() [1/4]

template<size_t N>

void c4::yml::WriterBuf::append ( const char(&) a[N] )

inlinenoexcept

Definition at line 53 of file writer_buf.hpp.

    {
        static_assert(N > 1, "empty string");
        RYML_ASSERT_BASIC_( ! m_buf.overlaps(a));
        if(m_pos + N-1 <= m_buf.len)
            memcpy(m_buf.str + m_pos, a, N-1);
        m_pos += N-1;
    }

append() [2/4]

void c4::yml::WriterBuf::append ( csubstr s )

inlinenoexcept

Definition at line 62 of file writer_buf.hpp.

    {
        RYML_ASSERT_BASIC_( ! s.overlaps(m_buf));
        if(s.len && m_pos + s.len <= m_buf.len)
            memcpy(m_buf.str + m_pos, s.str, s.len);
        m_pos += s.len;
    }

append() [3/4]

void c4::yml::WriterBuf::append ( const char c )

inlinenoexcept

Definition at line 70 of file writer_buf.hpp.

    {
        if(m_pos + 1 <= m_buf.len)
            m_buf.str[m_pos] = c;
        ++m_pos;
    }

append() [4/4]

void c4::yml::WriterBuf::append ( const char c, size_t num_times )

inlinenoexcept

Definition at line 77 of file writer_buf.hpp.

    {
        if(m_pos + num_times <= m_buf.len)
            memset(m_buf.str + m_pos, c, num_times);
        m_pos += num_times;
    }

Member Data Documentation

m_buf

substr c4::yml::WriterBuf::m_buf

Definition at line 22 of file writer_buf.hpp.

Referenced by WriterBuf(), append(), append(), append(), append(), and get_result().

m_pos

size_t c4::yml::WriterBuf::m_pos

Definition at line 23 of file writer_buf.hpp.

Referenced by WriterBuf(), append(), append(), append(), append(), and get_result().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/latest/src/c4/yml/writer_buf.hpp