ResultDart<S extends Object, F extends Object> class sealed

Base Result class

Receives two values F and S as F is an error and S is a success.

Available extensions

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.
filter(bool test(S success), F orElse(S success)) → ResultDart<S, F>
Returns this Result if it is a Failure or if the test predicate returns true for the encapsulated Success value. Otherwise, returns a Failure created by orElse.
flatMap<W extends Object>(ResultDart<W, F> fn(S success)) → ResultDart<W, F>
Returns a new Result, mapping any Success value using the given transformation and unwrapping the produced Result.
flatMapError<W extends Object>(ResultDart<S, W> fn(F error)) → ResultDart<S, W>
Returns a new Result, mapping any Error value using the given transformation and unwrapping the produced Result.
flatten() → ResultDart<S, F>

Available on ResultDart<ResultDart<S, F>, F>, provided by the FlattenResultExtension extension

Flattens a nested ResultDart by removing one level of nesting.
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 is Failure.
getOrDefault(S defaultValue) → S
Returns the encapsulated value if this instance represents Success or the defaultValue if it is Failure.
getOrElse(S onFailure(F failure)) → S
Returns the encapsulated value if this instance represents Success or the result of onFailure function for the encapsulated a Failure 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)) → ResultDart<W, F>
Returns a new Result, mapping any Success value using the given transformation.
mapError<W extends Object>(W fn(F error)) → ResultDart<S, W>
Returns a new Result, mapping any Error value using the given transformation.
mapFold<G extends Object, W extends Object>(G onSuccess(S success), W onFailure(F failure)) → ResultDart<G, W>
Returns a new Result, mapping any Success value using the given transformation and unwrapping the produced Result. Returns a new Result, mapping any Error value using the given transformation and unwrapping the produced Result.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onFailure(void onFailure(F failure)) → ResultDart<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)) → ResultDart<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) → ResultDart<W, F>
Change the Success value.
pureError<W extends Object>(W error) → ResultDart<S, W>
Change the Failure value.
pureFold<G extends Object, W extends Object>(G success, W failure) → ResultDart<G, W>
Returns a new Result, mapping any Success value using the given transformation and unwrapping the produced Result. Returns a new Result, mapping any Error value using the given transformation and unwrapping the produced Result.
recover<R extends Object>(ResultDart<S, R> onFailure(F failure)) → ResultDart<S, W>
Returns the encapsulated Result of the given transform function applied to the encapsulated a Failure or the original encapsulated value if it is success.
recoverWhen(bool test(F failure), ResultDart<S, F> onFailure(F failure)) → ResultDart<S, F>
Returns the encapsulated Result of the given onFailure function applied to the encapsulated Failure value only if test returns true. Otherwise, returns the original Failure unchanged. If this is a Success, returns it unchanged.
swap() → ResultDart<F, S>
Swap the values contained inside the Success and Failure of this Result.
tap(void fn(ResultDart<S, F> result)) → ResultDart<S, F>
Performs the given action on this Result regardless of whether it is a Success or Failure. Returns the original Result unchanged.
toAsyncResult() → AsyncResultDart<S, F>
Return a AsyncResult.
toEffect() → Effect<A, E>

Available on ResultDart<A, E>, provided by the ResultDartEffectInterop extension

toString() → String
A string representation of this object.
inherited
zip<S2 extends Object>(ResultDart<S2, F> other) → ResultDart<(S, S2), F>
Combines this Result with other into a single Result containing a Record of both success values. If either is a Failure, returns the first Failure encountered.

Operators

operator ==(Object other) → bool
The equality operator.
inherited