errors

package

v0.4.6 Latest Latest Go to latest Published: Mar 3, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Clyra-AI/proof

Links

Open Source Insights

Documentation ¶

Index ¶

func New(kind Kind, code, message string, opts ...Option) error
func Wrap(kind Kind, code, message string, cause error, opts ...Option) error
type Error
- func As(err error) (*Error, bool)
- func (e *Error) Error() string
- func (e *Error) Unwrap() error
type Kind
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(kind Kind, code, message string, opts ...Option) error

func Wrap ¶

func Wrap(kind Kind, code, message string, cause error, opts ...Option) error

Types ¶

type Error ¶

type Error struct {
	Kind    Kind   `json:"kind"`
	Code    string `json:"code"`
	Message string `json:"message"`
	Field   string `json:"field,omitempty"`
	Path    string `json:"path,omitempty"`
	// contains filtered or unexported fields
}

Error is a structured library error with optional field/path context.

func As ¶

func As(err error) (*Error, bool)

func (*Error) Error ¶

func (e *Error) Error() string

func (*Error) Unwrap ¶

func (e *Error) Unwrap() error

type Kind ¶

type Kind string

Kind classifies library errors for machine-readable handling.

const (
	KindInvalidInput      Kind = "invalid_input"
	KindValidation        Kind = "validation"
	KindVerification      Kind = "verification"
	KindDependencyMissing Kind = "dependency_missing"
	KindInternal          Kind = "internal"
)

type Option ¶

type Option func(*Error)

func WithCause ¶

func WithCause(err error) Option

func WithField ¶

func WithField(field string) Option

func WithPath ¶

func WithPath(path string) Option

Source Files ¶

View all Source files

errors.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL