Error Rt Freestanding¶

1

import "std/runtime/error_rt_freestanding";

Error struct¶

This is the generalized error type in Spice and part of the error handling mechanism.

Constructors¶

ctor¶

1

public p Error.ctor()

Construct a generic error with code 0 and a default message

ctor¶

1

public p Error.ctor(ErrorCode errorCode, string message)

Construct an error with the given code and message

Parameters

ctor¶

1

public p Error.ctor(string message)

Construct an error with the given message and code 1

Parameters

Methods¶

getCode¶

1

public inline f<ErrorCode> Error.getCode()

Retrieve error code

Returns: ErrorCode — Error code

getMessage¶

1

public inline f<string> Error.getMessage()

Retrieve error message as immutable string

Returns: string — Error message

isOk¶

1

public inline f<bool> Error.isOk()

Check if the error is set to the default error code 0, which means ok / no error

Returns: bool — Is set to error code 0

dumpTrace¶

1

public inline p Error.dumpTrace()

Prints the error message and the recorded error return trace. There is no stderr in freestanding mode and error return tracing is disabled, so this does nothing. It exists, so that code calling it compiles in both modes.

triggerPanic¶

1

public inline p Error.triggerPanic()

Panic with this error

ErrorCode enum¶