fallback

Documentation

Overview

Package fallback provides a Fallback policy.

Index

• type Fallback
  • func WithError[R any](err error) Fallback[R]
  • func WithFunc[R any](fallbackFunc func(exec failsafe.Execution[R]) (R, error)) Fallback[R]
  • func WithResult[R any](result R) Fallback[R]
• type FallbackBuilder
  • func BuilderWithError[R any](err error) FallbackBuilder[R]
  • func BuilderWithFunc[R any](fallbackFunc func(exec failsafe.Execution[R]) (R, error)) FallbackBuilder[R]
  • func BuilderWithResult[R any](result R) FallbackBuilder[R]

Types

type Fallback

type Fallback[R any] interface {
	failsafe.Policy[R]
}

Fallback is a Policy that handles failures using a fallback function, result, or error.

This type is concurrency safe.

func WithError

func WithError[R any](err error) Fallback[R]

WithError returns a Fallback for execution result type R that returns the err when an execution fails.

func WithFunc

func WithFunc[R any](fallbackFunc func(exec failsafe.Execution[R]) (R, error)) Fallback[R]

WithFunc returns a Fallback for execution result type R that uses fallbackFunc to handle a failed execution.

func WithResult

func WithResult[R any](result R) Fallback[R]

WithResult returns a Fallback for execution result type R that returns the result when an execution fails.

type FallbackBuilder

type FallbackBuilder[R any] interface {
	failsafe.FailurePolicyBuilder[FallbackBuilder[R], R]

	// OnFallbackExecuted registers the listener to be called when a Fallback has executed. The provided event will contain
	// the execution result and error returned by the Fallback.
	OnFallbackExecuted(listener func(event failsafe.ExecutionDoneEvent[R])) FallbackBuilder[R]

	// Build returns a new Fallback using the builder's configuration.
	Build() Fallback[R]
}

FallbackBuilder builds Fallback instances.

• By default, any error is considered a failure and will be handled by the policy. You can override this by specifying your own handle conditions. The default error handling condition will only be overridden by another condition that handles errors such as HandleErrors or HandleIf. Specifying a condition that only handles results, such as HandleResult will not replace the default error handling condition.
• If multiple handle conditions are specified, any condition that matches an execution result or error will trigger policy handling.

This type is not concurrency safe.

func BuilderWithError

func BuilderWithError[R any](err error) FallbackBuilder[R]

BuilderWithError returns a FallbackBuilder for execution result type R which builds Fallbacks that return the error when an execution fails.

func BuilderWithFunc

func BuilderWithFunc[R any](fallbackFunc func(exec failsafe.Execution[R]) (R, error)) FallbackBuilder[R]

BuilderWithFunc returns a FallbackBuilder for execution result type R which builds Fallbacks that use the fallbackFn to handle failed executions.

func BuilderWithResult

func BuilderWithResult[R any](result R) FallbackBuilder[R]

BuilderWithResult returns a FallbackBuilder for execution result type R which builds Fallbacks that return the result when an execution fails.