0c7cbb5368
This continues the work which switched the errors in the connmgr package to be compatible with errors.Is/As introduced in go 1.13 to make it match the best practices. The following is a high level overview of the changes: - Change the name of the error kind type to ErrorKind - Make error definitions constant - Add comments to all exported functions and types as required by the code contribution guidelines and various linters - Add a MakeError function to create the errors instead of creating the structs with unnamed fields which goes against standard Go recommendations - Add full test coverage to ensure the definitions work as intended
85 lines
2.9 KiB
Go
85 lines
2.9 KiB
Go
// Copyright (c) 2020 The Decred developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package connmgr
|
|
|
|
// ErrorKind identifies a kind of error. It has full support for errors.Is and
|
|
// errors.As, so the caller can directly check against an error kind when
|
|
// determining the reason for an error.
|
|
type ErrorKind string
|
|
|
|
const (
|
|
// ErrDialNil is used to indicate that Dial cannot be nil in
|
|
// the configuration.
|
|
ErrDialNil = ErrorKind("ErrDialNil")
|
|
|
|
// ErrBothDialsFilled is used to indicate that Dial and DialAddr
|
|
// cannot both be specified in the configuration.
|
|
ErrBothDialsFilled = ErrorKind("ErrBothDialsFilled")
|
|
|
|
// ErrTorInvalidAddressResponse indicates an invalid address was
|
|
// returned by the Tor DNS resolver.
|
|
ErrTorInvalidAddressResponse = ErrorKind("ErrTorInvalidAddressResponse")
|
|
|
|
// ErrTorInvalidProxyResponse indicates the Tor proxy returned a
|
|
// response in an unexpected format.
|
|
ErrTorInvalidProxyResponse = ErrorKind("ErrTorInvalidProxyResponse")
|
|
|
|
// ErrTorUnrecognizedAuthMethod indicates the authentication method
|
|
// provided is not recognized.
|
|
ErrTorUnrecognizedAuthMethod = ErrorKind("ErrTorUnrecognizedAuthMethod")
|
|
|
|
// ErrTorGeneralError indicates a general tor error.
|
|
ErrTorGeneralError = ErrorKind("ErrTorGeneralError")
|
|
|
|
// ErrTorNotAllowed indicates tor connections are not allowed.
|
|
ErrTorNotAllowed = ErrorKind("ErrTorNotAllowed")
|
|
|
|
// ErrTorNetUnreachable indicates the tor network is unreachable.
|
|
ErrTorNetUnreachable = ErrorKind("ErrTorNetUnreachable")
|
|
|
|
// ErrTorHostUnreachable indicates the tor host is unreachable.
|
|
ErrTorHostUnreachable = ErrorKind("ErrTorHostUnreachable")
|
|
|
|
// ErrTorConnectionRefused indicates the tor connection was refused.
|
|
ErrTorConnectionRefused = ErrorKind("ErrTorConnectionRefused")
|
|
|
|
// ErrTorTTLExpired indicates the tor request Time-To-Live (TTL) expired.
|
|
ErrTorTTLExpired = ErrorKind("ErrTorTTLExpired")
|
|
|
|
// ErrTorCmdNotSupported indicates the tor command is not supported.
|
|
ErrTorCmdNotSupported = ErrorKind("ErrTorCmdNotSupported")
|
|
|
|
// ErrTorAddrNotSupported indicates the tor address type is not supported.
|
|
ErrTorAddrNotSupported = ErrorKind("ErrTorAddrNotSupported")
|
|
)
|
|
|
|
// Error satisfies the error interface and prints human-readable errors.
|
|
func (e ErrorKind) Error() string {
|
|
return string(e)
|
|
}
|
|
|
|
// Error identifies an error related to the connection manager error. It has
|
|
// full support for errors.Is and errors.As, so the caller can ascertain the
|
|
// specific reason for the error by checking the underlying error.
|
|
type Error struct {
|
|
Description string
|
|
Err error
|
|
}
|
|
|
|
// Error satisfies the error interface and prints human-readable errors.
|
|
func (e Error) Error() string {
|
|
return e.Description
|
|
}
|
|
|
|
// Unwrap returns the underlying wrapped error.
|
|
func (e Error) Unwrap() error {
|
|
return e.Err
|
|
}
|
|
|
|
// MakeError creates an Error given a set of arguments.
|
|
func MakeError(kind ErrorKind, desc string) Error {
|
|
return Error{Err: kind, Description: desc}
|
|
}
|