Ok<T extends Object> class final

A Outcome that represents the success case of a Result, containing a value.

Inheritance
Implemented types
Available extensions

Constructors

Ok.new(T value)
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
value → T
no setteroverride

Methods

asResult() → Result<T>
Returns this as a base Result type.
inherited
end() → void
Suppresses the linter error must_use_outcome.
inherited
err() → None<Err<T>>
Safely gets the Err instance. Returns a Some on Err, or a None on Ok.
override
errOr(Result<T> other) → Result<T>
Returns this if it's Err, otherwise returns the other Result.
override
flatMap<R extends Object>(Result<R> noFutures(T value)) → Result<R>
Maps a Result<T> to Result<R> by applying a function that returns another Result.
override
flatten() → Result<T>

Available on Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>, provided by the FlattenResultExt8 extension

flatten() → Result<T>

Available on Result<Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>>, provided by the FlattenResultExt9 extension

flatten() → Result<T>

Available on Result<Result<Result<Result<Result<Result<Result<T>>>>>>>, provided by the FlattenResultExt7 extension

flatten() → Result<T>

Available on Result<Result<Result<Result<Result<Result<T>>>>>>, provided by the FlattenResultExt6 extension

flatten() → Result<T>

Available on Result<Result<T>>, provided by the FlattenResultExt2 extension

flatten() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>, provided by the FlattenOkExt7 extension

flatten() → Result<T>

Available on Result<Result<Result<Result<Result<T>>>>>, provided by the FlattenResultExt5 extension

flatten() → Result<T>

Available on Result<Result<Result<Result<T>>>>, provided by the FlattenResultExt4 extension

flatten() → Ok<T>

Available on Ok<Ok<T>>, provided by the FlattenOkExt2 extension

flatten() → Ok<T>

Available on Ok<Ok<Ok<T>>>, provided by the FlattenOkExt3 extension

flatten() → Ok<T>

Available on Ok<Ok<Ok<Ok<T>>>>, provided by the FlattenOkExt4 extension

flatten() → Result<T>

Available on Result<Result<Result<T>>>, provided by the FlattenResultExt3 extension

flatten() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<T>>>>>, provided by the FlattenOkExt5 extension

flatten() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>, provided by the FlattenOkExt6 extension

flatten() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>>, provided by the FlattenOkExt8 extension

flatten() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>>>, provided by the FlattenOkExt9 extension

flatten2() → Result<T>

Available on Result<Result<T>>, provided by the FlattenResultExt2 extension

flatten2() → Ok<T>

Available on Ok<Ok<T>>, provided by the FlattenOkExt2 extension

flatten3() → Result<T>

Available on Result<Result<Result<T>>>, provided by the FlattenResultExt3 extension

flatten3() → Ok<T>

Available on Ok<Ok<Ok<T>>>, provided by the FlattenOkExt3 extension

flatten4() → Ok<T>

Available on Ok<Ok<Ok<Ok<T>>>>, provided by the FlattenOkExt4 extension

flatten4() → Result<T>

Available on Result<Result<Result<Result<T>>>>, provided by the FlattenResultExt4 extension

flatten5() → Result<T>

Available on Result<Result<Result<Result<Result<T>>>>>, provided by the FlattenResultExt5 extension

flatten5() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<T>>>>>, provided by the FlattenOkExt5 extension

flatten6() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>, provided by the FlattenOkExt6 extension

flatten6() → Result<T>

Available on Result<Result<Result<Result<Result<Result<T>>>>>>, provided by the FlattenResultExt6 extension

flatten7() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>, provided by the FlattenOkExt7 extension

flatten7() → Result<T>

Available on Result<Result<Result<Result<Result<Result<Result<T>>>>>>>, provided by the FlattenResultExt7 extension

flatten8() → Result<T>

Available on Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>, provided by the FlattenResultExt8 extension

flatten8() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>>, provided by the FlattenOkExt8 extension

flatten9() → Result<T>

Available on Result<Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>>, provided by the FlattenResultExt9 extension

flatten9() → Ok<T>

Available on Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>>>, provided by the FlattenOkExt9 extension

fold(Result<Object>? onOk(Ok<T> ok), Result<Object>? onErr(Err<T> err)) → Result<Object>
Folds the two cases of this Result into a single new Result.
override
ifErr(void noFutures(Ok<T> self, Err<T> err)) → Result<T>
Performs a side-effect with the contained error if this is an Err.
override
ifOk(void noFutures(Ok<T> self, Ok<T> ok)) → Result<T>
Performs a side-effect with the contained value if this is an Ok.
override
isErr() → bool
Returns true if this Result is an Err.
override
isOk() → bool
Returns true if this Result is an Ok.
override
map<R extends Object>(R noFutures(T value)) → Ok<R>
Transforms the contained value using the mapper function noFutures while preserving the Outcome's structure.
override
map10<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>>>>>, provided by the MapOutcomeExt10 extension

map2<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Object>>, provided by the MapOutcomeExt2 extension

map3<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Outcome<Object>>>, provided by the MapOutcomeExt3 extension

map4<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Outcome<Outcome<Object>>>>, provided by the MapOutcomeExt4 extension

map5<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>, provided by the MapOutcomeExt5 extension

map6<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>, provided by the MapOutcomeExt6 extension

map7<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>>, provided by the MapOutcomeExt7 extension

map8<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>>>, provided by the MapOutcomeExt8 extension

map9<R extends Object>(R mapper(T)) → TResolvableOption<Object>

Available on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>>>>, provided by the MapOutcomeExt9 extension

mapErr(Err<T> noFutures(Err<T> err)) → Ok<T>
Transforms the inner Err instance if this is an Err.
override
mapOk(Ok<T> noFutures(Ok<T> ok)) → Ok<T>
Transforms the inner Ok instance if this is an Ok.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
ok() → Some<Ok<T>>
Safely gets the Ok instance. Returns a Some on Ok, or a None on Err.
override
okOr(Result<T> other) → Ok<T>
Returns this if it's Ok, otherwise returns the other Result.
override
orNull() → T?
Returns the contained Ok value or null.
override
raw({required FutureOr<Object> onErr(Err<Object> err), required FutureOr<Object> onNone()}) → FutureOr<Object>
The low-level primitive for reducing a Outcome chain. It recursively unwraps all Outcome layers to return the innermost raw value, forcing the caller to handle terminal states via callbacks.
inherited
rawAsync() → Async<Object>
Reduces any Outcome chain to a single Async.
inherited
rawSync() → Sync<Object>
Safely reduces any Outcome chain to a single Sync.
inherited
reduce<R extends Object>() → TResolvableOption<R>
Reduces any nested Outcome structure into a single TResolvableOption.
inherited
swap() → Resolvable<Result<T>>

Available on Result<Resolvable<T>>, provided by the SwapResultResolvableExt extension

swap() → Some<Result<T>>

Available on Result<Some<T>>, provided by the SwapResultSomeExt extension

swap() → Sync<Result<T>>

Available on Result<Sync<T>>, provided by the SwapResultSyncExt extension

swap() → Option<Result<T>>

Available on Result<None<T>>, provided by the SwapResultNoneExt extension

swap() → Option<Result<T>>

Available on Result<Option<T>>, provided by the SwapResultOptionExt extension

swap() → Async<Ok<T>>

Available on Ok<Async<T>>, provided by the SwapOkAsyncExt extension

swap() → Err<Ok<T>>

Available on Ok<Err<T>>, provided by the SwapOkErrExt extension

swap() → None<Ok<T>>

Available on Ok<None<T>>, provided by the SwapOkNoneExt extension

swap() → Option<Ok<T>>

Available on Ok<Option<T>>, provided by the SwapOkOptionExt extension

swap() → Resolvable<Ok<T>>

Available on Ok<Resolvable<T>>, provided by the SwapOkResolvableExt extension

swap() → Ok<Result<T>>

Available on Result<Ok<T>>, provided by the SwapResultOkExt extension

swap() → Some<Ok<T>>

Available on Ok<Some<T>>, provided by the SwapOkSomeExt extension

swap() → Sync<Ok<T>>

Available on Ok<Sync<T>>, provided by the SwapOkSyncExt extension

swap() → Async<Result<T>>

Available on Result<Async<T>>, provided by the SwapResultAsyncExt extension

swap() → Result<T>

Available on Result<Err<T>>, provided by the SwapResultErrExt extension

swap() → Result<Ok<T>>

Available on Ok<Result<T>>, provided by the SwapOkResultExt extension

toString() → String
A string representation of this object.
inherited
toUnit() → Ok<Unit>

Available on Ok<Object>, provided by the ToUnitOnObjectOk extension

toUnit() → Outcome<Unit>

Available on Outcome<Object>, provided by the ToUnitOnObjectOutcome extension

toUnit() → Result<Unit>

Available on Result<Object>, provided by the ToUnitOnObjectResult extension

toVoid() → Ok<void>

Available on Ok<T>, provided by the ToVoidOnOkExt extension

toVoid() → Outcome<void>

Available on Outcome<T>, provided by the ToVoidOnOutcomeExt extension

toVoid() → Result<void>

Available on Result<T>, provided by the ToVoidOnResultExt extension

transf<R extends Object>([R noFutures(T e)?]) → Result<R>
Transforms the Outcome's generic type from T to R.
override
unwrap() → T
Strongly discouraged: Unsafely returns the contained value.
override
unwrapOr(T fallback) → T
Returns the contained value, or the fallback if the Outcome is in an Err or None state.
override
wrapInAsync() → Async<M>

Available on M, provided by the WrapOnOutcomeExt extension

wrapInOk() → Ok<M>

Available on M, provided by the WrapOnOutcomeExt extension

wrapInResolvable() → Resolvable<M>

Available on M, provided by the WrapOnOutcomeExt extension

wrapInSome() → Some<M>

Available on M, provided by the WrapOnOutcomeExt extension

wrapInSync() → Sync<M>

Available on M, provided by the WrapOnOutcomeExt extension

wrapValueInAsync() → Ok<Async<T>>

Available on Ok<T>, provided by the WrapOnOkExt extension

wrapValueInAsync() → Outcome<Async<T>>

Available on M, provided by the WrapOnOutcomeExt extension

wrapValueInAsync() → Result<Async<T>>

Available on Result<T>, provided by the WrapOnResultExt extension

wrapValueInOk() → Ok<Ok<T>>

Available on Ok<T>, provided by the WrapOnOkExt extension

wrapValueInOk() → Outcome<Ok<T>>

Available on M, provided by the WrapOnOutcomeExt extension

wrapValueInOk() → Result<Ok<T>>

Available on Result<T>, provided by the WrapOnResultExt extension

wrapValueInResolvable() → Ok<Resolvable<T>>

Available on Ok<T>, provided by the WrapOnOkExt extension

wrapValueInResolvable() → Outcome<Resolvable<T>>

Available on M, provided by the WrapOnOutcomeExt extension

wrapValueInResolvable() → Result<Resolvable<T>>

Available on Result<T>, provided by the WrapOnResultExt extension

wrapValueInSome() → Ok<Some<T>>

Available on Ok<T>, provided by the WrapOnOkExt extension

wrapValueInSome() → Outcome<Some<T>>

Available on M, provided by the WrapOnOutcomeExt extension

wrapValueInSome() → Result<Some<T>>

Available on Result<T>, provided by the WrapOnResultExt extension

wrapValueInSync() → Ok<Sync<T>>

Available on Ok<T>, provided by the WrapOnOkExt extension

wrapValueInSync() → Outcome<Sync<T>>

Available on M, provided by the WrapOnOutcomeExt extension

wrapValueInSync() → Result<Sync<T>>

Available on Result<T>, provided by the WrapOnResultExt extension

Operators

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