package common

Import Path
	github.com/failsafe-go/failsafe-go/common (on go.dev)

Dependency Relation
	imports 0 packages, and imported by 4 packages

Involved Source Files

	  d doc.go
		Package common contains types that are common to the failsafe and policy packages.

	    result.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type PolicyResult[R] (struct)

		Type Parameters:
			R: any

		PolicyResult represents an execution result for a policy. If a policy is done handling a result or is no longer able
		to handle a result, such as when retries are exceeded, the PolicyResult should be marked as done.

		Fields (total 5)
			Done bool
				Done indicates whether an execution is done or if retries may be needed.

			Error error
			Result R
			Success bool
				Success indicates that a failure did not occur, or the policy was successful in handling the failure/

			SuccessAll bool
				SuccessAll indicates whether the policy and all inner policies were successful.

		Methods (total 2)
			(*PolicyResult[R]) WithDone(done bool, success bool) *PolicyResult[R]
				WithDone returns a new Result for the done and success values.

			(*PolicyResult[R]) WithFailure() *PolicyResult[R]
				WithFailure returns a new Result that is marked as not successful.

		As Outputs Of (at least 12)
			func (*PolicyResult)[R].WithDone(done bool, success bool) *PolicyResult[R]
			func (*PolicyResult)[R].WithFailure() *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/internal.FailureResult[R](err error) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.(*BaseExecutor)[R].OnFailure(exec policy.ExecutionInternal[R], result *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.(*BaseExecutor)[R].PostExecute(exec policy.ExecutionInternal[R], er *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.(*BaseExecutor)[R].PreExecute(_ policy.ExecutionInternal[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.ExecutionInternal[R].InitializeRetry() *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.ExecutionInternal[R].IsCanceledWithResult() (bool, *PolicyResult[R])
			func github.com/failsafe-go/failsafe-go/policy.ExecutionInternal[R].RecordResult(result *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.Executor[R].OnFailure(exec policy.ExecutionInternal[R], result *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.Executor[R].PostExecute(exec policy.ExecutionInternal[R], result *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.Executor[R].PreExecute(exec policy.ExecutionInternal[R]) *PolicyResult[R]
		As Inputs Of (at least 9)
			func github.com/failsafe-go/failsafe-go/policy.(*BaseExecutor)[R].OnFailure(exec policy.ExecutionInternal[R], result *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.(*BaseExecutor)[R].OnSuccess(exec policy.ExecutionInternal[R], result *PolicyResult[R])
			func github.com/failsafe-go/failsafe-go/policy.(*BaseExecutor)[R].PostExecute(exec policy.ExecutionInternal[R], er *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.ExecutionInternal[R].Cancel(result *PolicyResult[R])
			func github.com/failsafe-go/failsafe-go/policy.ExecutionInternal[R].CopyWithResult(result *PolicyResult[R]) failsafe.Execution[R]
			func github.com/failsafe-go/failsafe-go/policy.ExecutionInternal[R].RecordResult(result *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.Executor[R].OnFailure(exec policy.ExecutionInternal[R], result *PolicyResult[R]) *PolicyResult[R]
			func github.com/failsafe-go/failsafe-go/policy.Executor[R].OnSuccess(exec policy.ExecutionInternal[R], result *PolicyResult[R])
			func github.com/failsafe-go/failsafe-go/policy.Executor[R].PostExecute(exec policy.ExecutionInternal[R], result *PolicyResult[R]) *PolicyResult[R]

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.