Result<S extends Object, F extends Object> class
abstract
Base Result class
Receives two values F
and S
as F
is an error and S
is a success.
Constructors
- Result.failure(F e)
-
Build a Result that returns a Failure.
constfactory
- Result.success(S s)
-
Build a Result that returns a Failure.
constfactory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
exceptionOrNull(
) → F? - Returns the value of Failure or null.
-
flatMap<
W extends Object> (Result< W, F> fn(S success)) → Result<W, F> -
Returns a new
Result
, mapping anySuccess
value using the given transformation and unwrapping the producedResult
. -
flatMapError<
W extends Object> (Result< S, W> fn(F error)) → Result<S, W> -
Returns a new
Result
, mapping anyError
value using the given transformation and unwrapping the producedResult
. -
fold<
W> (W onSuccess(S success), W onFailure(F failure)) → W -
Returns the result of onSuccess for the encapsulated value
if this instance represents
Success
or the result of onError function for the encapsulated value if it isFailure
. -
getOrDefault(
S defaultValue) → S -
Returns the encapsulated value if this instance represents
Success
or thedefaultValue
if it isFailure
. -
getOrElse(
S onFailure(F failure)) → S -
Returns the encapsulated value if this instance represents
Success
or the result ofonFailure
function for the encapsulated aFailure
value. -
getOrNull(
) → S? - Returns the value of Success or null.
-
getOrThrow(
) → S - Returns the success value as a throwing expression.
-
isError(
) → bool - Returns true if the current result is an Failure.
-
isSuccess(
) → bool - Returns true if the current result is a Success.
-
map<
W extends Object> (W fn(S success)) → Result< W, F> -
Returns a new
Result
, mapping anySuccess
value using the given transformation. -
mapError<
W extends Object> (W fn(F error)) → Result< S, W> -
Returns a new
Result
, mapping anyError
value using the given transformation. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onFailure(
void onFailure(F failure)) → Result< S, F> - Performs the given action on the encapsulated Throwable exception if this instance represents failure. Returns the original Result unchanged.
-
onSuccess(
void onSuccess(S success)) → Result< S, F> - Performs the given action on the encapsulated value if this instance represents success. Returns the original Result unchanged.
-
pure<
W extends Object> (W success) → Result< W, F> - Change the Success value.
-
pureError<
W extends Object> (W error) → Result< S, W> - Change the Failure value.
-
recover<
R extends Object> (Result< S, R> onFailure(F failure)) → Result<S, R> -
Returns the encapsulated
Result
of the given transform function applied to the encapsulated aFailure
or the original encapsulated value if it is success. -
swap(
) → Result< F, S> - Swap the values contained inside the Success and Failure of this Result.
-
toAsyncResult(
) → AsyncResult< S, F> - Return a AsyncResult.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited