TinmanErrorDump

Description

sealed class Tinman.Core.TinmanErrorDump

Derived from

SerializableDisposableBase abstract

Represents a detailed error dump which may be included in a bug report.

When panicking (see TinmanException.Panic), the failing code may choose to assemble an error dump and write a dump file via Save. The output directory should be the settings directory of the enclosing module (see TinmanModule.Settings). On Windows, for example, the directory might look like this:

c:\Users\_USER_\AppData\Local\Tinman3D\_MODULE_\tinman-error._TIMESTAMP_._GUID_.dump

where _USER_ is the user name, _MODULE_ is BuildInformation.ModuleName of TinmanModule.Info, _TIMESTAMP_ is an UTC timestamp and _GUID_ uniquely identifies the code part that has assembled the error dump.

Public / Constants

Section​Tinman​Error

public constant SectionTinmanError → ("TinmanError":string)

An error dump section that contains the code output of a TinmanError object.

Public / Constructors

For

2 overloads

[OwnerReturn]
public static method For1 → (1)

guid in : string

[not-empty]
The unique type identifier of this error dump.

returns → TinmanErrorDump

The created TinmanErrorDump object.

Creates a new instance of TinmanErrorDump.

ValidatingException

If guid in is invalid.

[OwnerReturn]
public static method For2 → (1)

guid in : GUID

The unique type identifier of this error dump.

returns → TinmanErrorDump

The created TinmanErrorDump object.

Creates a new instance of TinmanErrorDump.

Load

[OwnerReturn]
public static method Load → (1)

file in : Path

[not-null]
The error dump file path.

returns → TinmanErrorDump

The loaded TinmanErrorDump object.

Loads an error dump from the given file.

IOException

If an I/O error has occurred.

Public / Methods

Save

[OwnerThis]
public method Save → (1)

directory in : Path

[not-null]
The directory into which to write the error dump.

returns → Path

The written error dump file.

Saves this error dump to a file.

IOException

If an I/O error has occurred.

Section​Read

public method SectionRead → (2)

sectionName in : string

[not-empty]
The section name.

mandatory in : bool

Is the section mandatory?

returns → ISerializer

A ISerializer object that can be used to read the section data or null iff sectionName in has not been found and mandatory is false.

Reads an error dump section.

TinmanException

If sectionName in has not been found and mandatory is true.

Section​Write

public method SectionWrite → (1)

sectionName in : string

[not-empty]
The section name.

returns → ISerializer

A ISerializer object that can be used to write the section data.

Writes an error dump section.

Public / Attributes

Guid

public attribute Guid → (get)

value : GUID

The dump GUID.

The unique type identifier of this error dump.

Sections

public attribute Sections → (get)

value : IBagConst<string>

[not-null]
The set of section names.

The error dump section names.

Timestamp

public attribute Timestamp → (get)

value : string

[not-empty]
The timestamp string.

The timestamp of this error dump.

See also

LowLevel.SystemTimeString

Serialization

Serial​Id

public static readonly attribute SerialId → (ISerialTypeInfo)

Serialization information about this type.