Description
Properties for messages.
Each message property is optional. When a message is sent through the plumbing, each node of the plumbing lattice may provide default values for properties that are not set, or may override properties that are set.
Thread safety: This object uses no global state, but is otherwise not thread-safe except where noted.
#include <Sawyer/Message.h>
Public Member Functions | |
| MesgProps | merge (const MesgProps &) const |
| Merge the specified properties into this object and return new properties. | |
| void | print (std::ostream &) const |
| Print the values for all properties. | |
Public Attributes | |
| Optional< std::string > | facilityName |
| The name of the logging facility that produced this message. | |
| Optional< Importance > | importance |
| The message importance level. | |
| boost::tribool | isBuffered |
| Whether the output buffered and emitted on a per-message basis. | |
| Optional< std::string > | completionStr |
| String to append to the end of each complete message. | |
| Optional< std::string > | interruptionStr |
| String to append when a partial message is interrupted. | |
| Optional< std::string > | cancelationStr |
| String to append to a partial message when it is destroyed. | |
| Optional< std::string > | lineTermination |
| Line termination for completion, interruption, and cancelation. | |
| boost::tribool | useColor |
| Whether to use ANSI escape sequences to colorize output. | |
Constructor & Destructor Documentation
◆ MesgProps()
Member Function Documentation
◆ merge()
Merge the specified properties into this object and return new properties.
Each property of the return value will be the value from this object, except when this object's property is missing, in which case the property value from the argument is used (which may also be missing).
◆ print()
| void Sawyer::Message::MesgProps::print | ( | std::ostream & | ) | const |
Print the values for all properties.
This is used mainly for debugging.
Member Data Documentation
◆ facilityName
| Optional<std::string> Sawyer::Message::MesgProps::facilityName |
The name of the logging facility that produced this message.
Definition at line 428 of file Message.h.
Referenced by Sawyer::Message::Mesg::Mesg(), and Sawyer::Message::Mesg::Mesg().
◆ importance
| Optional<Importance> Sawyer::Message::MesgProps::importance |
The message importance level.
Definition at line 429 of file Message.h.
Referenced by Sawyer::Message::Mesg::Mesg(), and Sawyer::Message::Mesg::Mesg().
◆ isBuffered
| boost::tribool Sawyer::Message::MesgProps::isBuffered |
◆ completionStr
| Optional<std::string> Sawyer::Message::MesgProps::completionStr |
◆ interruptionStr
| Optional<std::string> Sawyer::Message::MesgProps::interruptionStr |
◆ cancelationStr
| Optional<std::string> Sawyer::Message::MesgProps::cancelationStr |
◆ lineTermination
| Optional<std::string> Sawyer::Message::MesgProps::lineTermination |
◆ useColor
| boost::tribool Sawyer::Message::MesgProps::useColor |
The documentation for this struct was generated from the following file:
