Optional¶

1

import "std/data/optional";

Optional<T> struct¶

Optionals in Spice are wrappers around values, that allow them to be empty. This can be used as better alternative to nil for empty values.

Constructors¶

ctor¶

1

public p Optional.ctor()

Initialize optional without a value

ctor¶

1

public p Optional.ctor(const T& data)

Initialize optional with an initial value

Parameters

Methods¶

set¶

1

public inline p Optional.set(const T& data)

Set the value of the optional

Parameters

get¶

1

public inline f<T&> Optional.get()

Get the value of the optional

Returns: T& — Data value

orElse¶

1

public inline f<T&> Optional.orElse(T& defaultValue)

Get the value of the optional. If the optional is not present, return the default value

Parameters

Returns: T& — Data value or default value

orElseGet¶

1

public inline f<T&> Optional.orElseGet(f<T&>() getFct)

Get the value of the optional. If the optional is not present, return the value of getFct

Parameters

Returns: T& — Data value or value of the function

clear¶

1

public inline p Optional.clear()

Clears the value of the optional

isPresent¶

1

public inline f<bool> Optional.isPresent()

Checks if a value is present at the moment

Returns: bool — Present or not

Operators¶

operator==¶

1

public f<bool> operator==<T>(const Optional<T>& lhs, const Optional<T>& rhs)

Check if two optionals are equal, i.e. they have the same presence and equal payloads

Parameters

Returns: bool — Equal or not equal

operator!=¶

1

public f<bool> operator!=<T>(const Optional<T>& lhs, const Optional<T>& rhs)

Check if two optionals are not equal

Parameters

Returns: bool — Not equal or equal