errors

type AccessError interface {
	ContextError
	AccessError() AccessError
}

type AccessErrorBuilder interface {
	AccessError

	// Desc returns a copy with descriptor is set to desc.
	Desc(desc ErrorDescriptor) AccessErrorBuilder

	// DescMsg sets the descriptor with the provided string. For the best
	// experience, descMsg should be defined as a constant so that the error
	// users could use it to identify an error. For non-constant descriptor
	// use the Wrap method.
	DescMsg(descMsg string) AccessErrorBuilder

	// Wrap returns a copy with wrapped error is set to detailingError.
	Wrap(detailingError error) AccessErrorBuilder
}

type ArgumentError interface {
	CallError
	Unwrappable

	// ArgumentName returns the name of the offending argument. It might
	// be empty if there's only one argument.
	ArgumentName() string

	Descriptor() ErrorDescriptor
	FieldErrors() []NamedError
}

type ArgumentErrorBuilder interface {
	ArgumentError

	// Desc returns a copy with descriptor is set to desc.
	Desc(desc ErrorDescriptor) ArgumentErrorBuilder

	// DescMsg sets the descriptor with the provided string. For the best
	// experience, descMsg should be defined as a constant so that the error
	// users could use it to identify an error. For non-constant descriptor
	// use the Wrap method.
	DescMsg(descMsg string) ArgumentErrorBuilder

	// Hint provides a clue for the developers on how to fix the error.
	Hint(hintText string) ArgumentErrorBuilder

	Fieldset(fields ...NamedError) ArgumentErrorBuilder

	// Rewrap collects descriptor, wrapped, and fields from err and include
	// them into the new error.
	Rewrap(err error) ArgumentErrorBuilder

	// Wrap returns a copy with wrapped error is set to detailingError.
	Wrap(detailingError error) ArgumentErrorBuilder
}

type ArgumentErrorChecker struct {
	// contains filtered or unexported fields
}

type CallError interface {
	error
	CallError() CallError
}

type CallErrorSet interface {
	CallError
	ErrorSet
	CallErrors() []CallError
}

type ContextError interface {
	CallError
	ContextError() ContextError
}

type EntityError interface {
	Unwrappable
	EntityIdentifier() string
}

type EntityErrorSet interface {
	ErrorSet
	EntityErrors() []EntityError
}

type ErrorDescriptor interface {
	error
	ErrorDescriptorString() string
}

type ErrorSet interface {
	error
	Errors() []error
}

type NamedError interface {
	Unwrappable

	Name() string
	Value() any
}

type NamedErrorBuilder interface {
	NamedError

	// Desc returns a copy with descriptor is set to desc.
	Desc(desc ErrorDescriptor) NamedErrorBuilder

	// DescMsg sets the descriptor with the provided string. For the best
	// experience, descMsg should be defined as a constant so that the error
	// users could use it to identify an error. For non-constant descriptor
	// use the Wrap method.
	DescMsg(descMsg string) NamedErrorBuilder

	// Hint provides a clue for the developers on how to fix the error.
	Hint(hintText string) NamedErrorBuilder

	Fieldset(fields ...NamedError) NamedErrorBuilder

	// Rewrap collects descriptor, wrapped, and fields from err and include
	// them into the new error.
	Rewrap(err error) NamedErrorBuilder

	// Value provides the value associated to the name.
	Val(value any) NamedErrorBuilder

	// Wrap returns a copy with wrapped error is set to detailingError.
	Wrap(detailingError error) NamedErrorBuilder
}

type OperationError interface {
	Unwrappable

	// Returns the name of the operation.
	OperationName() string
}

type OperationErrorBuilder interface {
	OperationError

	// Hint provides a clue for the developers on how to fix the error.
	Hint(hintText string) OperationErrorBuilder

	Params(params ...NamedError) OperationErrorBuilder

	// Wrap returns a copy with wrapped error is set to detailingError.
	Wrap(detailingError error) OperationErrorBuilder
}

type Unwrappable interface {
	error
	Unwrap() error
}

type ValueError interface {
	error
	ValueError() ValueError
}

type ValueErrorBuilder interface {
	ValueError

	// Wrap returns a copy with wrapped error is set to detailingError.
	Wrap(detailingError error) ValueErrorBuilder
}

type ValueErrorDescriptor interface {
	ErrorDescriptor
	ValueErrorDescriptorString() string
}