entityErrors

Documentation

Overview

Package entityErrors provides a set of default errors for repeated use within the library.

Index

• Variables
• func DuplicateTag(tag, entity string) error
• func NoTag(tag, entity string) error

Variables

var (
	/*
		IncompatibleEntityType is an error that signifies that the
		Entity provided for a certain operation cannot be used for
		that operation due to a type mismatch.
	*/
	IncompatibleEntityType = fmt.Errorf("incompatible entity type")
	/*
		UndefinedAxis is an error which signifies that an Entity's
		axis fields are undefined. This could be raised, for example,
		when attempting to Filter for an Entity whose ID eField is
		primitive.NilObjectID and all axis fields are zeroed- in such
		a case, no Filter may be created.
	*/
	UndefinedAxis = fmt.Errorf("entity axis undefined (Axis Policy)")
	/*
		DBDecodeFail is an error which represents a failed attempt to
		read a value returned from the database.
	*/
	DBDecodeFail = fmt.Errorf("failed to decode DB value")
	/*
		AddedIDParseFail is an error which signifies that an operation
		to add an Entity has succeeded, but the attempt to read the
		new database ID of that Entity has failed.
	*/
	AddedIDParseFail = fmt.Errorf("added entity but failed to parse addedID")
	/*
		BodyIncomplete is an error which signifies that the required
		fields for an Entity have not been provided. It is returned
		when attempting to add an incomplete Entity to the database.
	*/
	BodyIncomplete = fmt.Errorf("entity body incomplete- will not add")
)

var (
	/*
		DBUninitialized is an error returned when a database
		pointer is nil.
	*/
	DBUninitialized = fmt.Errorf("null db pointer")
	/*
		IncompleteEntityMetadata is an error which signifies
		that an Entity's profile is incomplete. This could be
		as a result of undefined tags or tags with empty values.
	*/
	IncompleteEntityMetadata = fmt.Errorf("insufficient entity metadata")
	NoClassificationFields   = fmt.Errorf("no classification fields")
	InvalidDataType          = fmt.Errorf("data type invalid")
	InvalidEntityID          = fmt.Errorf("entityID invalid")
	EmbeddedWriteDataInvalid = fmt.Errorf("embedded write data invalid")
	InvalidEntityLink        = fmt.Errorf("invalid entity link")
)

var MuxCtxCorrupt = fmt.Errorf("%s: reteived EMuxContext corrupt", pkgPath)

var MuxCtxNotFound = fmt.Errorf("%s: EMuxContext not found in request", pkgPath)

Functions

func DuplicateTag

func DuplicateTag(tag, entity string) error

DuplicateTag is an error representing that a tag, which needs to have distinct values across Entities, has been found to have duplicates.

func NoTag

func NoTag(tag, entity string) error

NoTag is an error representing the absence of a required tag for a particular operation.