microfmt::md::writer Class Reference

#include <markdown.hpp>

Public Member Functions
constexpr	writer (const sink &out) noexcept
writer &	write (microfmt::string_view sv) &noexcept
writer &	put (char c) &noexcept
writer &	newline () &noexcept
writer &	pad (char c, size_t count) &noexcept
template<typename... Args>
writer &	print (microfmt::string_view fmt, const Args &...args) &noexcept
template<typename... Args>
writer &	println (microfmt::string_view fmt, const Args &...args) &noexcept
template<typename... Args>
writer &	heading (uint8_t level, microfmt::string_view fmt, const Args &...args) &noexcept
writer &	h1 (microfmt::string_view title) &noexcept
writer &	h2 (microfmt::string_view title) &noexcept
writer &	h3 (microfmt::string_view title) &noexcept
writer &	h4 (microfmt::string_view title) &noexcept
writer &	horizontal_rule () &noexcept
writer &	code_block_begin (microfmt::string_view lang="") &noexcept
writer &	code_block_end () &noexcept
template<typename Callable >
writer &	code_block (microfmt::string_view lang, Callable &&body) &noexcept
template<typename... Args>
writer &	blockquote (microfmt::string_view fmt, const Args &...args) &noexcept
template<typename... Args>
writer &	list_item (microfmt::string_view fmt, const Args &...args) &noexcept
template<typename... Args>
writer &	numbered_item (size_t index, microfmt::string_view fmt, const Args &...args) &noexcept
writer &	table_header (span< const column > cols) &noexcept
writer &	table_row_begin () &noexcept
writer &	table_cell (microfmt::string_view content, const column &col) &noexcept
template<size_t ScratchSize = 128, typename... Args>
writer &	table_cell_fmt (const column &col, microfmt::string_view fmt, const Args &...args) &noexcept
writer &	table_row_end () &noexcept
constexpr sink	get_sink () const &noexcept RELOCO_LIFETIMEBOUND
constexpr sink	get_sink () const &&=delete
template<typename... Args>
writer &	task_item (bool checked, microfmt::string_view fmt, const Args &...args) &noexcept
template<typename... Args>
writer &	nested_list_item (uint8_t indent_level, microfmt::string_view fmt, const Args &...args) &noexcept
template<typename Callable >
writer &	alert (admonition type, Callable &&body) &noexcept
template<typename... Args>
writer &	hexdump_block (microfmt::string_view summary, span< const uint8_t > data) &noexcept

Constructor & Destructor Documentation

writer()

constexpr microfmt::md::writer::writer ( const sink &  out )

inlineexplicitconstexprnoexcept

Member Function Documentation

alert()

template<typename Callable >

writer & microfmt::md::writer::alert ( admonition  type, Callable &&  body  ) &

inlinenoexcept

blockquote()

template<typename... Args>

writer & microfmt::md::writer::blockquote ( microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

code_block()

template<typename Callable >

writer & microfmt::md::writer::code_block ( microfmt::string_view  lang, Callable &&  body  ) &

inlinenoexcept

code_block_begin()

writer & microfmt::md::writer::code_block_begin ( microfmt::string_view  lang = "" ) &

inlinenoexcept

code_block_end()

writer & microfmt::md::writer::code_block_end ( ) &

inlinenoexcept

get_sink() [1/2]

constexpr sink microfmt::md::writer::get_sink ( ) const &&

constexprdelete

get_sink() [2/2]

constexpr sink microfmt::md::writer::get_sink ( ) const &

inlineconstexprnoexcept

h1()

writer & microfmt::md::writer::h1 ( microfmt::string_view  title ) &

inlinenoexcept

h2()

writer & microfmt::md::writer::h2 ( microfmt::string_view  title ) &

inlinenoexcept

h3()

writer & microfmt::md::writer::h3 ( microfmt::string_view  title ) &

inlinenoexcept

h4()

writer & microfmt::md::writer::h4 ( microfmt::string_view  title ) &

inlinenoexcept

heading()

template<typename... Args>

writer & microfmt::md::writer::heading ( uint8_t  level, microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

hexdump_block()

template<typename... Args>

writer & microfmt::md::writer::hexdump_block ( microfmt::string_view  summary, span< const uint8_t >  data  ) &

inlinenoexcept

horizontal_rule()

writer & microfmt::md::writer::horizontal_rule ( ) &

inlinenoexcept

list_item()

template<typename... Args>

writer & microfmt::md::writer::list_item ( microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

nested_list_item()

template<typename... Args>

writer & microfmt::md::writer::nested_list_item ( uint8_t  indent_level, microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

newline()

writer & microfmt::md::writer::newline ( ) &

inlinenoexcept

numbered_item()

template<typename... Args>

writer & microfmt::md::writer::numbered_item ( size_t  index, microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

pad()

writer & microfmt::md::writer::pad ( char  c, size_t  count  ) &

inlinenoexcept

print()

template<typename... Args>

writer & microfmt::md::writer::print ( microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

println()

template<typename... Args>

writer & microfmt::md::writer::println ( microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

put()

writer & microfmt::md::writer::put ( char  c ) &

inlinenoexcept

table_cell()

writer & microfmt::md::writer::table_cell ( microfmt::string_view  content, const column &  col  ) &

inlinenoexcept

table_cell_fmt()

template<size_t ScratchSize = 128, typename... Args>

writer & microfmt::md::writer::table_cell_fmt ( const column &  col, microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

table_header()

writer & microfmt::md::writer::table_header ( span< const column >  cols ) &

inlinenoexcept

table_row_begin()

writer & microfmt::md::writer::table_row_begin ( ) &

inlinenoexcept

table_row_end()

writer & microfmt::md::writer::table_row_end ( ) &

inlinenoexcept

task_item()

template<typename... Args>

writer & microfmt::md::writer::task_item ( bool  checked, microfmt::string_view  fmt, const Args &...  args  ) &

inlinenoexcept

write()

writer & microfmt::md::writer::write ( microfmt::string_view  sv ) &

inlinenoexcept

---

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

• include/microfmt/markdown.hpp