clienterr

package

v1.3.0 Latest Latest Go to latest Published: Sep 3, 2026 License: MIT Imports: 7 Imported by: 0

Details

This section is empty.

View Source

var BadRequest = ClientErrorDefinition{
	// contains filtered or unexported fields
}

View Source

var NotFound = ClientErrorDefinition{
	// contains filtered or unexported fields
}

View Source

var UnprocessableEntity = ClientErrorDefinition{
	// contains filtered or unexported fields
}

func Response(c *gin.Context, err error, log *zerolog.Logger)

Response sends the error as a JSON response to the client.

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

Builder is a fluent API for building client (4xx) errors.

func (b *Builder) Detailed(errType, detail string, args ...any) *Builder

Detailed changes the error type and adds a detail message.

func (b *Builder) Err() *errorx.Error

Err returns the client error as an errorx.Error (which also implements error interface).

func (b *Builder) Response(c *gin.Context, log *zerolog.Logger)

Response sends the client error as a JSON response to the client.

func (b *Builder) WithInstance(parts ...any) *Builder

WithInstance sets the instance field of the problem details.

func (b *Builder) Wrap(cause error) *Builder

Wrap wraps the provided error as the cause of the client error.

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

ClientErrorDefinition is a definition of a client error.

func (c ClientErrorDefinition) Detailed(errType, detail string, args ...any) *Builder

Detailed is a shortcut for creating a new client error with a detailed message.

func (c ClientErrorDefinition) New() *Builder

New creates a new client error builder.

type Mapper interface {
	IfOfType(typeToMatch *errorx.Type) OnMatch
	Finalize() error
	Response(c *gin.Context, log *zerolog.Logger)
}

Mapper is a fluent API for mapping errors to client errors.

func Map(err error) Mapper

Map creates a new Mapper instance.

type OnMatch interface {
	Then(errToReturn *Builder) Mapper
}

OnMatch provides a fluent API for defining the response to return when a match is found.