CppLogging::TextLayout Class Reference

Text layout. More...

#include <text_layout.h>

Inheritance diagram for CppLogging::TextLayout:

Public Member Functions
	TextLayout (const std::string &pattern="{UtcDateTime} [{Thread}] {Level} {Logger} - {Message}{EndLine}")
	Initialize text logging layout with a given pattern. More...
	TextLayout (const TextLayout &)=delete
	TextLayout (TextLayout &&layout)=delete
virtual	~TextLayout ()
TextLayout &	operator= (const TextLayout &)=delete
TextLayout &	operator= (TextLayout &&layout)=delete
const std::string &	pattern () const noexcept
	Get the text layout pattern. More...
void	LayoutRecord (Record &record) override
	Layout the given logging record into a raw buffer. More...
Public Member Functions inherited from CppLogging::Element
virtual bool	IsStarted () const noexcept
	Is the logging element started? More...
virtual bool	Start ()
	Start the logging element. More...
virtual bool	Stop ()
	Stop the logging element. More...

Detailed Description

Text layout.

Text layout converts the given logging record into the text string using a given pattern. Text layout pattern is a string with a special placeholders provided inside curly brackets ("{}").

Supported placeholders:

• {UtcDateTime} / {LocalDateTime} - converted to the UTC/local date & time (e.g. "1997-07-16T19:20:30.123Z" / "1997-07-16T19:20:30.123+01:00")
• {UtcDate} / {LocalDate} - converted to the UTC/local date (e.g. "1997-07-16")
• {Time} / {LocalTime} - converted to the UTC/local time (e.g. "19:20:30.123Z" / "19:20:30.123+01:00")
• {UtcYear} / {LocalYear} - converted to the UTC/local four-digits year (e.g. "1997")
• {UtcMonth} / {LocalMonth} - converted to the UTC/local two-digits month (e.g. "07")
• {UtcDay} / {LocalDay} - converted to the UTC/local two-digits day (e.g. "16")
• {UtcHour} / {LocalHour} - converted to the UTC/local two-digits hour (e.g. "19")
• {UtcMinute} / {LocalMinute} - converted to the UTC/local two-digits minute (e.g. "20")
• {UtcSecond} / {LocalSecond} - converted to the UTC/local two-digits second (e.g. "30")
• {UtcTimezone} / {LocalTimezone} - converted to the UTC/local timezone suffix (e.g. "Z" / "+01:00")
• {Millisecond} - converted to the three-digits millisecond (e.g. "123")
• {Microsecond} - converted to the three-digits microsecond (e.g. "123")
• {Nanosecond} - converted to the three-digits nanosecond (e.g. "789")
• {Thread} - converted to the thread Id (e.g. "0x0028F3D8")
• {Level} - converted to the logging level
• {Logger} - converted to the logger name
• {Message} - converted to the log message
• {EndLine} - converted to the end line suffix (e.g. Unix "\n" or Windows "\r\n")

Thread-safe.

Definition at line 47 of file text_layout.h.

Constructor & Destructor Documentation

TextLayout() [1/3]

CppLogging::TextLayout::TextLayout ( const std::string &  pattern = "{UtcDateTime} [{Thread}] {Level} {Logger} - {Message}{EndLine}" )

explicit

Initialize text logging layout with a given pattern.

Parameters

pattern

- Layout pattern

Definition at line 804 of file text_layout.cpp.

TextLayout() [2/3]

CppLogging::TextLayout::TextLayout ( const TextLayout &  )

delete

TextLayout() [3/3]

CppLogging::TextLayout::TextLayout ( TextLayout &&  layout )

delete

~TextLayout()

CppLogging::TextLayout::~TextLayout ( )

virtual

Definition at line 815 of file text_layout.cpp.

Member Function Documentation

LayoutRecord()

void CppLogging::TextLayout::LayoutRecord ( Record &  record )

overridevirtual

Layout the given logging record into a raw buffer.

This method will update the raw filed of the given logging record.

Parameters

record

- Logging record

Implements CppLogging::Layout.

Definition at line 823 of file text_layout.cpp.

operator=() [1/2]

TextLayout& CppLogging::TextLayout::operator= ( const TextLayout &  )

delete

operator=() [2/2]

TextLayout& CppLogging::TextLayout::operator= ( TextLayout &&  layout )

delete

pattern()

const std::string & CppLogging::TextLayout::pattern ( ) const

noexcept

Get the text layout pattern.

Definition at line 821 of file text_layout.cpp.

---

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

• include/logging/layouts/text_layout.h
• source/logging/layouts/text_layout.cpp