feat: typed decode and encode errors with the key path
Assisted-by: GLM 5.3 Flash
This commit is contained in:
@@ -21,6 +21,7 @@ package interpres
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"unicode/utf8"
|
||||
)
|
||||
@@ -36,6 +37,58 @@ func (e *SyntaxError) Error() string {
|
||||
return fmt.Sprintf("interpres: line %d: %s", e.Line, e.Msg)
|
||||
}
|
||||
|
||||
// A DecodeError wraps a decoding failure with the key path at which it
|
||||
// happened. Path lists one segment per level from the document root, the
|
||||
// outermost key first: a key contributes its name and an array element its
|
||||
// bracketed index, so the path of the weight field in the first item reads
|
||||
// ["items", "[0]", "weight"]. The rendered message is unchanged by the type;
|
||||
// read it programmatically with errors.AsType:
|
||||
//
|
||||
// if de, ok := errors.AsType[*interpres.DecodeError](err); ok {
|
||||
// fmt.Println(de.Path, de.Err)
|
||||
// }
|
||||
type DecodeError struct {
|
||||
// Path is the key path from the document root, outermost key first.
|
||||
Path []string
|
||||
// Err is the failure at that path.
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *DecodeError) Error() string { return e.Path[0] + ": " + e.Err.Error() }
|
||||
|
||||
// Unwrap returns the failure the path points at.
|
||||
func (e *DecodeError) Unwrap() error { return e.Err }
|
||||
|
||||
// newDecodeError wraps err with one path segment. The rest of the path comes
|
||||
// from the DecodeError err already carries, if any: the decoder wraps each
|
||||
// key and index on its way down, so the innermost wrap holds the deepest
|
||||
// segments and each outer wrap prepends one.
|
||||
func newDecodeError(key string, err error) *DecodeError {
|
||||
path := make([]string, 0, 4)
|
||||
path = append(path, key)
|
||||
if de, ok := errors.AsType[*DecodeError](err); ok {
|
||||
path = append(path, de.Path...)
|
||||
}
|
||||
return &DecodeError{Path: path, Err: err}
|
||||
}
|
||||
|
||||
// An EncodeError wraps an encoding failure with the key path of the value
|
||||
// that failed, in the notation of a TOML document: fields join with dots and
|
||||
// an array element carries its bracketed index, so the path of the third
|
||||
// port under server reads "server.ports[2]". The rendered message is
|
||||
// unchanged by the type; read it programmatically with errors.AsType.
|
||||
type EncodeError struct {
|
||||
// Path is the key path of the failing value.
|
||||
Path string
|
||||
// Err is the failure at that path.
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e *EncodeError) Error() string { return "interpres: " + e.Path + ": " + e.Err.Error() }
|
||||
|
||||
// Unwrap returns the failure the path points at.
|
||||
func (e *EncodeError) Unwrap() error { return e.Err }
|
||||
|
||||
// Parse decodes a TOML document into a nested map[string]any.
|
||||
//
|
||||
// Values are mapped to Go types as follows: strings to string, integers to
|
||||
|
||||
Reference in New Issue
Block a user