ActionResult class abstract

A 2-state result represents synchronised action with no return value It could be either succeeded or failed

Typically wrapped in a future as the return value of an action execution.

Future<ActionResult> deleteObject(String id);

ActionResult.completed creates the CompletedResult, indicates the action is completed ActionResult.failed creates the FailedResult, indicates the action is failed

See also

Implemented types

Constructors

ActionResult()
Alias to ActionResult.completed
factory
ActionResult.completed()
creates the CompletedResult This factory always returns a const result
factory
ActionResult.failed(dynamic error, [StackTrace? stackTrace])
creates the FailedResult error is the Error/Exception fails the action stackTrace indicates where the error was thrown, it is optional
const
factory
ActionResult.from(StatedResult result)
Create ActionResult from any other result
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
hasValue → bool
Return true when query resut has a value, either it is intial value or the result after running query It also indicates whether state implemented the ValueResult contract, regardless the type of the value
no setterinherited
isFailed → bool
Return ture when the query/action has finished with error
no setterinherited
isFinished → bool
Return true when query/action has been finished either with or without error
no setterinherited
isNotStarted → bool
Return true when query/action hasn't been started
no setterinherited
isSucceeded → bool
Return true when query/action has finished successfully, regardless it is an action or query
no setterinherited
isWaiting → bool
Return true when query/action is being processed
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

asFailed() → FailedResult
inherited
asValueResult<T>() → ValueResult<T>
inherited
map<TR>({required ResultMapper<TR> completed, required FailedResultMapper<TR> failed}) → TR
Pattern match the result
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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