Class LoggerResult

Namespace

Stride.Core.Diagnostics

Assembly

Stride.Core.dll

A logger that stores messages locally useful for internal log scenarios.

public class LoggerResult : Logger, ILogger, IProgressStatus

Inheritance

object

Logger

LoggerResult

Implements

ILogger

IProgressStatus

Derived

AssetCompilerResult

PackageSessionResult

ForwardingLoggerResult

LoggerValueResult<T>

MaterialShaderResult

CompilerResults

Inherited Members

Logger.EnableTypes

Logger.MessageLogged

Logger.MinimumLevelEnabled

Logger.IsDebugEnabled

Logger.IsVerboseEnabled

Logger.HasErrors

Logger.ActivateLog(LogMessageType, LogMessageType, bool)

Logger.ActivateLog(LogMessageType, bool)

Logger.Activated(LogMessageType)

Logger.Log(ILogMessage)

Logger.Verbose(string, Exception, CallerInfo)

Logger.Verbose(string, CallerInfo)

Logger.Debug(string, Exception, CallerInfo)

Logger.Debug(string, CallerInfo)

Logger.Info(string, Exception, CallerInfo)

Logger.Info(string, CallerInfo)

Logger.Warning(string, Exception, CallerInfo)

Logger.Warning(string, CallerInfo)

Logger.Error(string, Exception, CallerInfo)

Logger.Error(string, CallerInfo)

Logger.Fatal(string, Exception, CallerInfo)

Logger.Fatal(string, CallerInfo)

Extension Methods

LoggerExtensions.Debug(ILogger, string, CallerInfo)

LoggerExtensions.Debug(ILogger, string, Exception, CallerInfo)

LoggerExtensions.Error(ILogger, string, CallerInfo)

LoggerExtensions.Error(ILogger, string, Exception, CallerInfo)

LoggerExtensions.Fatal(ILogger, string, CallerInfo)

LoggerExtensions.Fatal(ILogger, string, Exception, CallerInfo)

LoggerExtensions.Info(ILogger, string, CallerInfo)

LoggerExtensions.Info(ILogger, string, Exception, CallerInfo)

LoggerExtensions.Verbose(ILogger, string, CallerInfo)

LoggerExtensions.Verbose(ILogger, string, Exception, CallerInfo)

LoggerExtensions.Warning(ILogger, string, CallerInfo)

LoggerExtensions.Warning(ILogger, string, Exception, CallerInfo)

Constructors

LoggerResult(string)

Initializes a new instance of the LoggerResult class.

public LoggerResult(string moduleName = null)

Parameters

moduleName string

Properties

IsLoggingProgressAsInfo

Gets or sets a value indicating whether this instance is logging progress as information. Default is true.

public bool IsLoggingProgressAsInfo { get; set; }

Property Value

bool

true if this instance is logging progress as information; otherwise, false.

Messages

Gets the messages logged to this instance.

public TrackingCollection<ILogMessage> Messages { get; }

Property Value

TrackingCollection<ILogMessage>

The messages.

Module

Gets the module name. read-write.

public string Module { get; set; }

Property Value

string

The module name.

Methods

Clear()

Clears all messages.

public virtual void Clear()

CopyTo(ILogger)

Copies all messages to another instance.

public void CopyTo(ILogger results)

Parameters

results ILogger

The results.

LogRaw(ILogMessage)

Internal method used to log a message. All Info, Debug, Error...etc. methods are calling this method.

protected override void LogRaw(ILogMessage logMessage)

Parameters

logMessage ILogMessage

The log message.

Progress(string)

Notifies progress on this instance.

public void Progress(string message)

Parameters

message string

The message.

Progress(string, int, int)

Notifies progress on this instance.

public void Progress(string message, int currentStep, int stepCount)

Parameters

message string

The message.

currentStep int

The current step.

stepCount int

The step count.

ToText()

Returns a string representation of this

public string ToText()

Returns

string

System.String.

Events

ProgressChanged

Occurs when the progress changed for this logger.

public event EventHandler<ProgressStatusEventArgs> ProgressChanged

Event Type

EventHandler<ProgressStatusEventArgs>