retry.go

// Copyright 2023 xgfone
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package retry provides some retry policies to call a function.
package retry

import "context"

// Retry is an interface to retry the function until a condition reaches.
type Retry interface {
	// If f returns true or nil, it terminates retry.
	Run(c context.Context, f func(context.Context) (success bool, err error)) error
}