gojekyll/utils/errors.go

package utils

import (
	"fmt"
	"os"
)

// A WrappedError decorates an error with a message
type WrappedError interface {
	error
	Cause() error
}

// WrapError returns an error decorated with a message.
// If the error is nil, it returns nil.
func WrapError(err error, m string) error {
	if err == nil {
		return nil
	}
	return &wrappedError{cause: err, message: m}
}

type wrappedError struct {
	cause   error
	message string
}

func (we *wrappedError) Cause() error {
	return we.cause
}

func (we *wrappedError) Error() string {
	return fmt.Sprintf("%s: %s", we.message, we.cause)
}

// A PathError is an error with a source path.
//
// An os.PathError is unfortunately not a PathError, but this is still
// useful for deciding whether to wrap other errors.
type PathError interface {
	WrappedError
	Path() string
}

type pathError struct {
	cause error
	path  string
}

func (pe *pathError) Cause() error {
	return pe.cause
}

func (pe *pathError) Error() string {
	return fmt.Sprintf("%s: %s", pe.path, pe.cause)
}

func (pe *pathError) Path() string {
	return pe.path
}

// WrapPathError returns an error that will print with a path.\
// It wraps its argument if it is not nil and does not already provide a path.
func WrapPathError(err error, path string) error {
	if err == nil {
		return nil
	}
	switch err := err.(type) {
	case PathError:
		return err
	case *os.PathError:
		return err
	default:
		return &pathError{path: path, cause: err}
	}
}