Skip to content

Commit

Permalink
Document stdout_/stderr_writer
Browse files Browse the repository at this point in the history
  • Loading branch information
mattiasflodin committed Aug 31, 2016
1 parent ebcc3b0 commit d18804e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions doc/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Table of Contents
- [severity_log](#severity_log)
- [Custom writers](#custom-writers)
- [file_writer](#file_writer)
- [stdout_writer and stderr_writer](#stdout_writer-and-stderr_writer)
- [Custom string formatting](#custom-string-formatting)
- [output_buffer](#output_buffer)
- [Custom fields in policy_log](#custom-fields-in-policy_log)
Expand Down Expand Up @@ -437,6 +438,28 @@ On Linux, the writer classifies following error codes as temporary errors:
<code>EDQUOT</code> (user quota reached), <code>EIO</code>
(low-level I/O error). All other errors are classified as permanent.
stdout_writer and stderr_writer
===============================
`stdout_writer` and `stderr_writer` write to the respective standard streams.
```c++
// #include <reckless/stdout_writer.hpp>
class stdout_writer : public writer {
public:
stdout_writer();
std::size_t write(void const* pbuffer, std::size_t count,
std::error_code& ec) noexcept override;
};
class stderr_writer : public writer {
public:
stderr_writer();
std::size_t write(void const* pbuffer, std::size_t count,
std::error_code& ec) noexcept override;
};
```

Custom string formatting
================================================
Both `policy_log` and `severity_log` make use of the `template_formatter`
Expand Down

0 comments on commit d18804e

Please sign in to comment.