Menu
Search

API Documentation

version 2.081.0

overview

View source code
Display the source code in std/experimental/logger/core.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Class std.experimental.logger.core.Logger

This class is the base of every logger. In order to create a new kind of logger a deriving class needs to implement the writeLogMsg method. By default this is not thread-safe.

class Logger ;

It is also possible to override the three methods beginLogMsg, logMsgPart and finishLogMsg together, this option gives more flexibility.

Constructors

NameDescription
this Every subclass of Logger has to call this constructor from their constructor. It sets the LogLevel, and creates a fatal handler. The fatal handler will throw an Error if a log call is made with level LogLevel.fatal.

Properties

NameTypeDescription
fatalHandler[get, set] void delegate()This delegate is called in case a log message with LogLevel.fatal gets logged.
logLevel[get, set] LogLevelThe LogLevel determines if the log call are processed or dropped by the Logger. In order for the log call to be processed the LogLevel of the log call must be greater or equal to the LogLevel of the logger.

Methods

NameDescription
forwardMsg This method allows forwarding log entries from one logger to another.
log This method logs data with the LogLevel of the used Logger.
log This function logs data to the used Logger with a specific LogLevel.
log This function logs data to the used Logger depending on a explicitly passed condition with the LogLevel of the used Logger.
log This function logs data to the used Logger with the LogLevel of the used Logger.
logf This function logs data to the used Logger with a specific LogLevel and depending on a condition in a printf-style manner.
logf This function logs data to the used Logger with a specific LogLevel in a printf-style manner.
logf This function logs data to the used Logger depending on a condition with the LogLevel of the used Logger in a printf-style manner.
logf This method logs data to the used Logger with the LogLevel of the this Logger in a printf-style manner.
factory Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
opCmp Compare with another Object obj.
opEquals Test whether this is equal to o. The default implementation only compares by identity (using the is operator). Generally, overrides for opEquals should attempt to compare objects by their contents.
toHash Compute hash function for Object.
toString Convert Object to a human readable string.
finishLogMsg Signals that the message has been written and no more calls to logMsgPart follow.
logMsgPart Logs a part of the log message.
writeLogMsg A custom logger must implement this method in order to work in a MultiLogger and ArrayLogger.

Inner structs

NameDescription
LogEntry LogEntry is a aggregation combining all information associated with a log message. This aggregation will be passed to the method writeLogMsg.

Aliases

NameDescription
critical This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
criticalf This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
error This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
errorf This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
fatal This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
fatalf This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
info This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
infof This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
trace This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
tracef This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
warning This template provides the log functions for the Logger class with the LogLevel encoded in the function name.
warningf This template provides the log functions for the Logger class with the LogLevel encoded in the function name.

Templates

NameDescription
memLogFunctions This template provides the log functions for the Logger class with the LogLevel encoded in the function name.

Authors

License