CircuitFailurePredicate class abstract
Predicate that decides whether a failure counts for the circuit breaker.
Callers can extend this class or use CircuitFailurePredicate.where to provide domain-specific circuit failure classification.
- Inheritance
-
- Object
- ContextPredicate<
CircuitFailureContext, CircuitFailurePredicate> - CircuitFailurePredicate
Constructors
- CircuitFailurePredicate()
-
Creates a circuit failure predicate.
const
- CircuitFailurePredicate.any()
-
Counts every non-cancellation outcome.
factory
- CircuitFailurePredicate.exception()
-
Counts ordinary exception outcomes except cancellation.
factory
-
CircuitFailurePredicate.exceptionWhere(FutureOr<
bool> test(Object error, StackTrace stackTrace)) -
Counts exception outcomes matching
test.factory -
CircuitFailurePredicate.where(FutureOr<
bool> test(CircuitFailureContext context)) -
Counts outcomes matching
test.factory
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
-
and(
CircuitFailurePredicate left, CircuitFailurePredicate right) → CircuitFailurePredicate -
Builds an AND composition.
inherited
-
build(
FutureOr< bool> shouldHandle(CircuitFailureContext context)) → CircuitFailurePredicate -
Wraps
shouldHandlein the concrete predicate type.override -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
not(
CircuitFailurePredicate inner) → CircuitFailurePredicate -
Builds a NOT composition.
inherited
-
or(
CircuitFailurePredicate left, CircuitFailurePredicate right) → CircuitFailurePredicate -
Builds an OR composition.
inherited
-
shouldHandle(
CircuitFailureContext context) → FutureOr< bool> -
Returns true when
contextshould count as a circuit failure.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator &(
CircuitFailurePredicate other) → CircuitFailurePredicate -
Combines this value with
otherusing AND semantics.inherited -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator |(
CircuitFailurePredicate other) → CircuitFailurePredicate -
Combines this value with
otherusing OR semantics.inherited -
operator ~(
) → CircuitFailurePredicate -
Negates this value.
inherited
Static Methods
-
exceptionType<
E extends Object> () → CircuitFailurePredicate -
Counts failures of type
E. -
result<
T> (FutureOr< bool> test(T result)) → CircuitFailurePredicate -
Counts result outcomes matching
test.