errcontext

Documentation

Overview

Package errcontext defines a context-aware error handling mechanism using interfaces and a struct that allows sending and receiving a single error.

Index

• Variables
• type ErrCloseSender
• type ErrCloser
• type ErrContexer
  • func New(ctx context.Context) ErrContexer
• type ErrReceiver
• type ErrSender

Variables

var (
	ErrAlreadyCalled = fmt.Errorf("already called")
)

Types

type ErrCloseSender

type ErrCloseSender interface {
	ErrCloser
	ErrSender
}

ErrCloseSender embeds ErrCloser and ErrSender interfaces.

type ErrCloser

type ErrCloser interface {
	Close()
}

ErrCloser defines the method to close an error

type ErrContexer

type ErrContexer interface {
	ErrCloser
	ErrReceiver
	ErrSender
}

ErrContexer embeds ErrReceiver, ErrSender and ErrCloser interfaces.

func New

func New(ctx context.Context) ErrContexer

New creates ErrContexer with an error channel and context. When used ctx is nil, background context is used => Receive() calls are blocking until Send call or Close call.

type ErrReceiver

type ErrReceiver interface {
	Receive() error
}

ErrReceiver defines the method to receive an error.

type ErrSender

type ErrSender interface {
	Send(error)
}

ErrSender defines the method to send an error.