c4::yml::WriterFile Struct Reference

A writer that outputs to a C file handle, defaulting to stdout. More...

#include <writer_file.hpp>

Public Member Functions
	WriterFile (FILE *f=nullptr) noexcept
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
FILE *	m_file

Detailed Description

A writer that outputs to a C file handle, defaulting to stdout.

This writer is much faster than WriterOStream and should be preferred to it.

Definition at line 21 of file writer_file.hpp.

Constructor & Destructor Documentation

WriterFile()

c4::yml::WriterFile::WriterFile ( FILE * f = nullptr )

inlinenoexcept

Definition at line 25 of file writer_file.hpp.

: m_file(f ? f : stdout) {}

Member Function Documentation

append() [1/4]

template<size_t N>

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

inlinenoexcept

Definition at line 28 of file writer_file.hpp.

    {
        static_assert(N > 1, "empty string");
        (void)fwrite(a, sizeof(char), N - 1, m_file);
    }

append() [2/4]

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

inlinenoexcept

Definition at line 34 of file writer_file.hpp.

    {
        if(s.len)
        {
            C4_SUPPRESS_WARNING_GCC_CLANG_WITH_PUSH("-Wsign-conversion")
            (void)fwrite(s.str, sizeof(csubstr::char_type), s.len, m_file);
            C4_SUPPRESS_WARNING_GCC_CLANG_POP
        }
    }

append() [3/4]

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

inlinenoexcept

Definition at line 44 of file writer_file.hpp.

    {
        (void)fputc(c, m_file);
    }

append() [4/4]

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

inlinenoexcept

Definition at line 49 of file writer_file.hpp.

    {
        for(size_t i = 0; i < num_times; ++i)
            (void)fputc(c, m_file);
    }

Member Data Documentation

m_file

FILE* c4::yml::WriterFile::m_file

Definition at line 23 of file writer_file.hpp.

Referenced by WriterFile(), append(), append(), append(), and append().

---

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_file.hpp