Err<T extends Object> class final

A Outcome that represents the failure case of a Result, containing an error value.

Inheritance

• Object
• Outcome<T>
• Result<T>
• Err

Implemented types

• SyncImpl<T>
• Exception

Available extensions

• FlattenErrExt2
• FlattenErrExt3
• FlattenErrExt4
• FlattenErrExt5
• FlattenErrExt6
• FlattenErrExt7
• FlattenErrExt8
• FlattenErrExt9
• FlattenResultExt2
• FlattenResultExt3
• FlattenResultExt4
• FlattenResultExt5
• FlattenResultExt6
• FlattenResultExt7
• FlattenResultExt8
• FlattenResultExt9
• MapOutcomeExt2
• MapOutcomeExt3
• MapOutcomeExt4
• MapOutcomeExt5
• MapOutcomeExt6
• MapOutcomeExt7
• MapOutcomeExt8
• MapOutcomeExt9
• MapOutcomeExt10
• SwapErrAsyncExt
• SwapErrNoneExt
• SwapErrOkExt
• SwapErrOptionExt
• SwapErrResolvableExt
• SwapErrResultExt
• SwapErrSomeExt
• SwapErrSyncExt
• SwapResultAsyncExt
• SwapResultErrExt
• SwapResultNoneExt
• SwapResultOkExt
• SwapResultOptionExt
• SwapResultResolvableExt
• SwapResultSomeExt
• SwapResultSyncExt
• ToUnitOnObjectErr
• ToUnitOnObjectOutcome
• ToUnitOnObjectResult
• ToVoidOnErrExt
• ToVoidOnOutcomeExt
• ToVoidOnResultExt
• WrapOnErrExt
• WrapOnOutcomeExt
• WrapOnResultExt

Constructors

Err(FutureOr<Object> value, {int? statusCode, StackTrace? stackTrace})

Creates a new Err from value and an optional statusCode.

Err.fromModel(ErrModel model)

Creates an Err from an ErrModel.

factory

Properties

error → Object

no setter

hashCode → int

The hash code for this object.

no setter, inherited

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stackTrace → Trace

The stack trace captured when the Err was created.

final

statusCode → Option<int>

An optional HTTP status code associated with the error.

final

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

value → Object

no setter, override

Methods

asResult() → Result<T>

Returns this as a base Result type.

inherited

end() → void

Suppresses the linter error must_use_outcome.

inherited

err() → Some<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<T>>>>>>>, provided by the FlattenResultExt7 extension

flatten() → Result<T>

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

flatten() → Err<T>

Available on Err<Err<Err<Err<Err<Err<T>>>>>>, provided by the FlattenErrExt6 extension

flatten() → Err<T>

Available on Err<Err<T>>, provided by the FlattenErrExt2 extension

flatten() → Err<T>

Available on Err<Err<Err<T>>>, provided by the FlattenErrExt3 extension

flatten() → Err<T>

Available on Err<Err<Err<Err<T>>>>, provided by the FlattenErrExt4 extension

flatten() → Err<T>

Available on Err<Err<Err<Err<Err<T>>>>>, provided by the FlattenErrExt5 extension

flatten() → Err<T>

Available on Err<Err<Err<Err<Err<Err<Err<T>>>>>>>, provided by the FlattenErrExt7 extension

flatten() → Err<T>

Available on Err<Err<Err<Err<Err<Err<Err<Err<T>>>>>>>>, provided by the FlattenErrExt8 extension

flatten() → Err<T>

Available on Err<Err<Err<Err<Err<Err<Err<Err<Err<T>>>>>>>>>, provided by the FlattenErrExt9 extension

flatten() → Result<T>

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

flatten() → Result<T>

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

flatten() → Result<T>

Available on Result<Result<Result<Result<T>>>>, provided by the FlattenResultExt4 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<Result<Result<T>>>>>>, provided by the FlattenResultExt6 extension

flatten() → Result<T>

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

flatten2() → Err<T>

Available on Err<Err<T>>, provided by the FlattenErrExt2 extension

flatten2() → Result<T>

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

flatten3() → Result<T>

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

flatten3() → Err<T>

Available on Err<Err<Err<T>>>, provided by the FlattenErrExt3 extension

flatten4() → Err<T>

Available on Err<Err<Err<Err<T>>>>, provided by the FlattenErrExt4 extension

flatten4() → Result<T>

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

flatten5() → Err<T>

Available on Err<Err<Err<Err<Err<T>>>>>, provided by the FlattenErrExt5 extension

flatten5() → Result<T>

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

flatten6() → Err<T>

Available on Err<Err<Err<Err<Err<Err<T>>>>>>, provided by the FlattenErrExt6 extension

flatten6() → Result<T>

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

flatten7() → Err<T>

Available on Err<Err<Err<Err<Err<Err<Err<T>>>>>>>, provided by the FlattenErrExt7 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() → Err<T>

Available on Err<Err<Err<Err<Err<Err<Err<Err<T>>>>>>>>, provided by the FlattenErrExt8 extension

flatten9() → Err<T>

Available on Err<Err<Err<Err<Err<Err<Err<Err<Err<T>>>>>>>>>, provided by the FlattenErrExt9 extension

flatten9() → Result<T>

Available on Result<Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>>, provided by the FlattenResultExt9 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(Err<T> self, Err<T> err)) → Err<T>

Performs a side-effect with the contained error if this is an Err.

override

ifOk(void noFutures(Err<T> self, Ok<T> ok)) → Err<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)) → Err<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)) → Err<T>

Transforms the inner Err instance if this is an Err.

override

mapOk(Ok<T> noFutures(Ok<T> ok)) → Err<T>

Transforms the inner Ok instance if this is an Ok.

override

matchError<E extends Object>() → Option<E>

Returns an Option containing the error if its type matches E.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

ok() → None<Ok<T>>

Safely gets the Ok instance. Returns a Some on Ok, or a None on Err.

override

okOr(Result<T> other) → Result<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() → Option<Err<T>>

Available on Err<Option<T>>, provided by the SwapErrOptionExt extension

swap() → Option<Result<T>>

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

swap() → Ok<Result<T>>

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

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<Option<T>>, provided by the SwapResultOptionExt extension

swap() → Async<Err<T>>

Available on Err<Async<T>>, provided by the SwapErrAsyncExt extension

swap() → None<Err<T>>

Available on Err<None<T>>, provided by the SwapErrNoneExt extension

swap() → Ok<Err<T>>

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

swap() → Result<T>

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

swap() → Resolvable<Err<T>>

Available on Err<Resolvable<T>>, provided by the SwapErrResolvableExt extension

swap() → Result<Err<T>>

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

swap() → Async<Result<T>>

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

swap() → Sync<Err<T>>

Available on Err<Sync<T>>, provided by the SwapErrSyncExt extension

swap() → Some<Err<T>>

Available on Err<Some<T>>, provided by the SwapErrSomeExt extension

toJson() → Map<String, dynamic>

Converts this Err to a JSON map.

toModel() → ErrModel

Converts this Err to a data model for serialization.

toString() → String

A string representation of this object.

override

toUnit() → Err<Unit>

Available on Err<Object>, provided by the ToUnitOnObjectErr 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() → Result<void>

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

toVoid() → Outcome<void>

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

toVoid() → Err<void>

Available on Err<T>, provided by the ToVoidOnErrExt extension

transf<R extends Object>([R noFutures(T e)?]) → Err<R>

Transforms the Outcome's generic type from T to R.

override

transfErr<R extends Object>() → Err<R>

Transforms the Err's generic type from T to R while preserving the contained error.

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() → Err<Async<T>>

Available on Err<T>, provided by the WrapOnErrExt 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() → Err<Ok<T>>

Available on Err<T>, provided by the WrapOnErrExt 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() → Err<Resolvable<T>>

Available on Err<T>, provided by the WrapOnErrExt 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() → Err<Some<T>>

Available on Err<T>, provided by the WrapOnErrExt 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() → Err<Sync<T>>

Available on Err<T>, provided by the WrapOnErrExt 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