Files
openmethod/doc/trace_output.adoc
Jean-Louis Leroy 5e0fa8ee4b inception
2025-03-08 15:31:25 -05:00

46 lines
930 B
Plaintext

## trace_output
### Synopsis
Defined in <boost/openmethod/policies/basic_policy.hpp>.
```c++
namespace boost::openmethod::policies {
struct trace_output {};
}
```
---
### Description
`trace_output` is a facet used to write trace messages.
`initialize` can be directed to describe the classes and methods in a policy,
and how the dispatch tables are built, by including this facet in the policy,
and setting `trace_enabled` to `true`. The content and the format of the
description is not documented, beyond the guarantee that it provides an
exhaustive account of table construction, and may change between major, minor
and patch versions.
### Requirements
#### trace_enabled
```c++
static bool trace_enabled;
```
`true` if tracing is enabled, `false` otherwise.
#### trace_stream
```c++
static RestrictedOutputStream trace_stream;
```
A static variable that satisfies the requirements of `RestrictedOutputStream`.