//
// DISCLAIMER
//
// Copyright 2023 ArangoDB GmbH, Cologne, Germany
//
// 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.
//
// Copyright holder is ArangoDB GmbH, Cologne, Germany
//

package operator

import "fmt"

func Stop(msg string, args ...interface{}) error {
	return stop{
		message: fmt.Sprintf(msg, args...),
	}
}

type stop struct {
	message string
}

func (r stop) Error() string {
	return r.message
}

func IsStop(err error) bool {
	if err == nil {
		return false
	}

	if _, ok := err.(stop); ok {
		return true
	}

	return false
}