Package: github.com/failsafe-go/failsafe-go/policy

type BaseAbortablePolicy[R] (struct) Type Parameters: R: any BaseAbortablePolicy provides a base for implementing policies that can be aborted or canceled. Methods (total 6) (*BaseAbortablePolicy[R]) AbortIf(predicate func(R, error) bool) (*BaseAbortablePolicy[R]) AbortOnErrorTypes(errs ...any) (*BaseAbortablePolicy[R]) AbortOnErrors(errs ...error) (*BaseAbortablePolicy[R]) AbortOnResult(result R) (*BaseAbortablePolicy[R]) IsAbortable(result R, err error) bool (*BaseAbortablePolicy[R]) IsConfigured() bool

type BaseDelayablePolicy[R] (struct) Type Parameters: R: any BaseDelayablePolicy provides a base for implementing DelayablePolicyBuilder. Fields (total 2) Delay time.Duration DelayFunc failsafe.DelayFunc[R] Methods (total 3) (*BaseDelayablePolicy[R]) ComputeDelay(exec failsafe.ExecutionAttempt[R]) time.Duration ComputeDelay returns a computed delay else -1 if no delay could be computed. (*BaseDelayablePolicy[R]) WithDelay(delay time.Duration) (*BaseDelayablePolicy[R]) WithDelayFunc(delayFunc failsafe.DelayFunc[R])

type BaseExecutor[R] (struct) Type Parameters: R: any BaseExecutor provides base implementation of Executor. Fields (total 2) BaseFailurePolicy *BaseFailurePolicy[R] Executor Executor[R] Methods (total 10) (*BaseExecutor[R]) Apply(innerFn func(failsafe.Execution[R]) *common.PolicyResult[R]) func(failsafe.Execution[R]) *common.PolicyResult[R] ( BaseExecutor[R]) HandleErrorTypes(errs ...any) ( BaseExecutor[R]) HandleErrors(errs ...error) ( BaseExecutor[R]) HandleIf(predicate func(R, error) bool) ( BaseExecutor[R]) HandleResult(result R) (*BaseExecutor[R]) IsFailure(result R, err error) bool (*BaseExecutor[R]) OnFailure(exec ExecutionInternal[R], result *common.PolicyResult[R]) *common.PolicyResult[R] (*BaseExecutor[R]) OnSuccess(exec ExecutionInternal[R], result *common.PolicyResult[R]) (*BaseExecutor[R]) PostExecute(exec ExecutionInternal[R], er *common.PolicyResult[R]) *common.PolicyResult[R] (*BaseExecutor[R]) PreExecute(_ ExecutionInternal[R]) *common.PolicyResult[R]

type BaseFailurePolicy[R] (struct) Type Parameters: R: any BaseFailurePolicy provides a base for implementing FailurePolicyBuilder. Methods (total 7) (*BaseFailurePolicy[R]) HandleErrorTypes(errs ...any) (*BaseFailurePolicy[R]) HandleErrors(errs ...error) (*BaseFailurePolicy[R]) HandleIf(predicate func(R, error) bool) (*BaseFailurePolicy[R]) HandleResult(result R) (*BaseFailurePolicy[R]) IsFailure(result R, err error) bool (*BaseFailurePolicy[R]) OnFailure(listener func(event failsafe.ExecutionEvent[R])) (*BaseFailurePolicy[R]) OnSuccess(listener func(event failsafe.ExecutionEvent[R]))

type ExecutionInternal[R] (interface) Type Parameters: R: any Methods (total 23) ( ExecutionInternal[R]) AttemptStartTime() time.Time AttemptStartTime returns the time that the most recent execution attempt started at. ( ExecutionInternal[R]) Attempts() int Attempts returns the number of execution attempts so far, including attempts that are currently in progress and attempts that were blocked before being executed, such as by a CircuitBreaker or RateLimiter. These can include an initial execution along with retries and hedges. ( ExecutionInternal[R]) Cancel(result *common.PolicyResult[R]) Cancel cancels the execution with the result. ( ExecutionInternal[R]) Canceled() <-chan struct{} Canceled returns a channel that is closed when the execution is canceled, either by an external Context or a timeout.Timeout. ( ExecutionInternal[R]) Context() context.Context Context returns the context configured for the execution, else context.Background if none was configured. For executions involving a timeout or hedge, each attempt will get a separate child context. ( ExecutionInternal[R]) CopyForCancellable() failsafe.Execution[R] CopyForCancellable creates a cancellable child copy of the execution based on the current execution's context. ( ExecutionInternal[R]) CopyForHedge() failsafe.Execution[R] CopyForHedge creates a copy of the execution marked as a hedge. ( ExecutionInternal[R]) CopyWithResult(result *common.PolicyResult[R]) failsafe.Execution[R] CopyWithResult returns a copy of the failsafe.Execution with the result. If the result is nil, this will preserve a copy of the lastResult and lastError. This is useful before passing the execution to an event listener, otherwise these may be changed if the execution is canceled. ( ExecutionInternal[R]) ElapsedAttemptTime() time.Duration ElapsedAttemptTime returns the elapsed time since the last execution attempt began. ( ExecutionInternal[R]) ElapsedTime() time.Duration ElapsedTime returns the elapsed time since initial execution attempt began. ( ExecutionInternal[R]) Executions() int Executions returns the number of completed executions. Executions that are blocked, such as when a CircuitBreaker is open, are not counted. ( ExecutionInternal[R]) Hedges() int Hedges returns the number of hedges that have been executed so far, including hedges that are currently in progress. ( ExecutionInternal[R]) InitializeRetry() *common.PolicyResult[R] InitializeRetry prepares a new execution retry. If the retry could not be initialized because was canceled, the associated cancellation result is returned. ( ExecutionInternal[R]) IsCanceled() bool IsCanceled returns whether the execution has been canceled by an external Context or a timeout.Timeout. ( ExecutionInternal[R]) IsCanceledWithResult() (bool, *common.PolicyResult[R]) IsCanceledWithResult returns whether the execution is canceled, along with the cancellation result, if any. ( ExecutionInternal[R]) IsFirstAttempt() bool IsFirstAttempt returns true when Attempts is 1, meaning this is the first execution attempt. ( ExecutionInternal[R]) IsHedge() bool IsHedge returns true when the execution is part of a hedged attempt. ( ExecutionInternal[R]) IsRetry() bool IsRetry returns true when Attempts is > 1, meaning the execution is being retried. ( ExecutionInternal[R]) LastError() error LastError returns the error, if any, from the last execution attempt. ( ExecutionInternal[R]) LastResult() R LastResult returns the result, if any, from the last execution attempt. ( ExecutionInternal[R]) RecordResult(result *common.PolicyResult[R]) *common.PolicyResult[R] RecordResult records an execution result, such as before a retry attempt, and returns the result or the cancel result, if any. ( ExecutionInternal[R]) Retries() int Retries returns the number of retries so far, including retries that are currently in progress. ( ExecutionInternal[R]) StartTime() time.Time StartTime returns the time that the initial execution attempt started at. Implements (at least 3) ExecutionInternal : github.com/failsafe-go/failsafe-go.Execution[R] ExecutionInternal : github.com/failsafe-go/failsafe-go.ExecutionAttempt[R] ExecutionInternal : github.com/failsafe-go/failsafe-go.ExecutionInfo[R] As Inputs Of (at least 8) func (*BaseExecutor)[R].OnFailure(exec ExecutionInternal[R], result *common.PolicyResult[R]) *common.PolicyResult[R] func (*BaseExecutor)[R].OnSuccess(exec ExecutionInternal[R], result *common.PolicyResult[R]) func (*BaseExecutor)[R].PostExecute(exec ExecutionInternal[R], er *common.PolicyResult[R]) *common.PolicyResult[R] func (*BaseExecutor)[R].PreExecute(_ ExecutionInternal[R]) *common.PolicyResult[R] func Executor[R].OnFailure(exec ExecutionInternal[R], result *common.PolicyResult[R]) *common.PolicyResult[R] func Executor[R].OnSuccess(exec ExecutionInternal[R], result *common.PolicyResult[R]) func Executor[R].PostExecute(exec ExecutionInternal[R], result *common.PolicyResult[R]) *common.PolicyResult[R] func Executor[R].PreExecute(exec ExecutionInternal[R]) *common.PolicyResult[R]

type Executor[R] (interface) Type Parameters: R: any Executor handles execution and execution results according to a policy. May contain pre-execution and post-execution behaviors. Each Executor makes its own determination about whether an execution result is a success or failure. Methods (total 6) ( Executor[R]) Apply(innerFn func(failsafe.Execution[R]) *common.PolicyResult[R]) func(failsafe.Execution[R]) *common.PolicyResult[R] Apply performs an execution by calling PreExecute and returning any result, else calling the innerFn PostExecute. If an Executor delays or blocks during execution, it must check that the execution was not canceled in the meantime, else return the ExecutionInternal.Result if it was. ( Executor[R]) IsFailure(result R, err error) bool IsFailure returns whether the result is a failure according to the corresponding policy. ( Executor[R]) OnFailure(exec ExecutionInternal[R], result *common.PolicyResult[R]) *common.PolicyResult[R] OnFailure performs post-execution handling for a result that is considered a failure according to IsFailure, possibly creating a new result, else returning the original result. ( Executor[R]) OnSuccess(exec ExecutionInternal[R], result *common.PolicyResult[R]) OnSuccess performs post-execution handling for a result that is considered a success according to IsFailure. ( Executor[R]) PostExecute(exec ExecutionInternal[R], result *common.PolicyResult[R]) *common.PolicyResult[R] PostExecute performs synchronous post-execution handling for an execution result. ( Executor[R]) PreExecute(exec ExecutionInternal[R]) *common.PolicyResult[R] PreExecute is called before execution to return an alternative result or error, such as if execution is not allowed or needed.