errors.go

package portal

import (
	"fmt"
)

var (
	// ErrorInternallyHandled indicates that a real error does not exist, but a cancel was necessary somewhere in the portal.
	ErrorInternallyHandled = fmt.Errorf("\x00")

	ErrorListMultipleSplitters                  = fmt.Errorf("list: cannot use multiple splitters")
	ErrorListNoSplitters                        = fmt.Errorf("list: no splitter was found")
	ErrorFeatureListCannotCombineExcludeInclude = fmt.Errorf("features: cannot combine exclude and include lists!")
	ErrorCommandListCannotCombineExcludeInclude = fmt.Errorf("commands: cannot combine exclude and include lists!")
)

func Errors(errs ...error) []error {
	return errs
}

// ErrorRuntimeExists indicates that a portal runtime already exists which matches the given portal ID.
func ErrorRuntimeExists(portalID string) error {
	return fmt.Errorf("portal: runtime already exists: %s", portalID)
}

// ErrorEventArgNotFound indicates that an event argument was not found when processing a given command.
func ErrorEventArgNotFound(field string) error {
	return fmt.Errorf("event: argument: not found: %s", field)
}

// ErrorEventArgInvalidValue indicates that an event argument was found invalid when processing a given command.
func ErrorEventArgInvalidValue(field string) error {
	return fmt.Errorf("event: argument: invalid value: %s", field)
}

// ErrorFeatureNotFound indicates that a feature with the given ID was not found in the portal network.
func ErrorFeatureNotFound(featureID string) error {
	return fmt.Errorf("feature: not found: %s", featureID)
}

// ErrorFeatureExists indicates that a feature with the given ID already exists somewhere in the portal network.
func ErrorFeatureExists(featureID string) error {
	return fmt.Errorf("feature: already exists: %s", featureID)
}

func ErrorFeatureAPI(featureID string, featureAPI, portalAPI int) error {
	return fmt.Errorf("feature: mismatched API %d with portal API %d: %s", featureAPI, portalAPI, featureID)
}

// ErrorFeatureThreadAlreadyRunning indicates that a feature's transport thread is already running.
func ErrorFeatureThreadAlreadyRunning(featureID string) error {
	return fmt.Errorf("feature: thread already running: %s", featureID)
}

// ErrorFeatureAlreadyOpen indicates that a feature is already open.
func ErrorFeatureAlreadyOpen(featureID string) error {
	return fmt.Errorf("feature: already open: %s", featureID)
}

// ErrorFeatureAlreadyClosed indicates that a feature is already closed.
func ErrorFeatureAlreadyClosed(featureID string) error {
	return fmt.Errorf("feature: already closed: %s", featureID)
}

// ErrorFeatureNotOpen indicates that a feature is not open for operations.
func ErrorFeatureNotOpen(featureID string) error {
	return fmt.Errorf("feature: not open: %s", featureID)
}

// ErrorFeatureNotReady indicates that a feature is not ready to ingest the network.
func ErrorFeatureNotReady(featureID string) error {
	return fmt.Errorf("feature: not ready: %s", featureID)
}