Result Rt¶

1

import "std/runtime/result_rt";

Result<T> struct¶

Result in Spice are wrappers around values, that allow to either provide a value or an error object. This is useful for functions that return a value, but also can fail. The error can then be dealt with on the caller side e.g. using the panic builtin.

Constructors¶

ctor¶

1

public p Result.ctor(const T& data)

Construct a successful result holding the given data

Parameters

ctor¶

1

public p Result.ctor(const Error& error)

Construct a failed result holding the given error

Parameters

Methods¶

unwrap¶

1

public inline f<T&> Result.unwrap()

Returns the stored data object. If an error is present, this function will panic.

The returned reference is borrowed - the result stays the owner of the data and destructs it when it goes out of scope. To take ownership of a heap payload, move it out of the result: heap byte* p = result.unwrapAndMove();

Returns: T&

unwrapOr¶

1

public inline f<T&> Result.unwrapOr(const T& alternativeValue)

If no error is present, return the stored data object, otherwise the given value.

Parameters

Returns: T&

unwrapOrElse¶

1

public inline f<T&> Result.unwrapOrElse(f<T&>(const Error&) callback)

If no error is present, return the stored data object, otherwise invoke the given callback.

Parameters

Returns: T&

unwrapAndMove¶

1

public inline f<T> Result.unwrapAndMove()

Move the stored data object out of the result object If an error is present, this function will panic.

Returns: T

getErr¶

1

public inline f<Error&> Result.getErr()

Return the enclosed error object.

Returns: Error&

isOk¶

1

public inline f<bool> Result.isOk()

Checks if the result contains any data.

Returns: bool

isErr¶

1

public inline f<bool> Result.isErr()

Checks if the result contains an error.

Returns: bool

dumpTrace¶

1

public inline p Result.dumpTrace()

Prints the recorded error return trace to stderr. Forwards to the enclosed error's dumpTrace(), see there.

Functions¶

ok¶

1

public inline f<Result<T>> ok<T>(const T& data)

Returns a result object with a value and no error.

Parameters

Returns: Result<T>

err¶

1

public inline f<Result<T>> err<T>(const Error& error)

Returns a result object with an error and no value.

Parameters

Returns: Result<T>

err¶

1

public inline f<Result<T>> err<T>(int code, string message)

Returns a result object with an error and no value.

Parameters

Returns: Result<T>

err¶

1

public inline f<Result<T>> err<T>(string message)

Returns a result object with an error and no value.

Parameters

Returns: Result<T>