xerrors

package

v0.16.1 Latest Latest Go to latest Published: Jun 23, 2026 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tableauio/tableau

Links

Open Source Insights

Documentation ¶

Overview ¶

Code generated by internal/tools/cmd/ecode. DO NOT EDIT.

Index ¶

Constants
Variables
func E0001(sheetName string, bookName string) error
func E0002(filename string, messageName string, error_ error, lines string) error
func E0003(name string, position1 string, position2 string) error
func E2000(type_ string, value string, min any, max any) error
func E2001(refer string, messageName string) error
func E2002(value string, refer string) error
func E2003(value string, sequence int64) error
func E2004(value any, range_ string) error
func E2005(key any) error
func E2006(value any, enumName any) error
func E2007(value any, error_ error) error
func E2008(value any, error_ error) error
func E2009(key any, fieldName string) error
func E2010(typeValue any, fieldNumber any) error
func E2011() error
func E2012(fieldType any, value any, error_ error) error
func E2013(value any, error_ error) error
func E2014(column string) error
func E2015(column string, bookName string, sheetName string) error
func E2016(firstNonePresentIndex int, nextPresentIndex int) error
func E2017(mapType string) error
func E2018(keyName string) error
func E2019(value string, error_ error) error
func E2020(value string, error_ error) error
func E2021(enumType any, enumValue1 any, enumValue2 any, alias any) error
func E2022(fieldName string, key any) error
func E2023(currValue any, prevValue any) error
func E2024(value string, error_ error) error
func E2025(value string, pattern string) error
func E2026(value any, prevValue any, order string) error
func E2027(violation string, fieldValue any) error
func E2028(elem any) error
func E3000(sheetSpecifier string, pattern string) error
func E3001(sheetName string, bookName string) error
func E3002(error_ error) error
func E3003(glob string) error
func New(msg string) error
func NewKV(msg string, keysAndValues ...any) error
func Newf(format string, args ...any) error
func Wrap(err error) error
func WrapKV(err error, keysAndValues ...any) error
func Wrapf(err error, format string, args ...any) error
type Collector
- func NewCollector(maxErrs int) *Collector
- func (c *Collector) Collect(err error) error
- func (c *Collector) HasErrors() bool
- func (c *Collector) IsFull() bool
- func (c *Collector) Join() error
- func (c *Collector) NewChild(maxErrs int) *Collector
- func (c *Collector) NewGroup(ctx context.Context) *Group
type Desc
- func NewDesc(err error) *Desc
- func (d *Desc) GetValue(key string) any
- func (d *Desc) String() string
- func (d *Desc) Stringify(withDebug bool) string
type Frame
- func (f Frame) Format(s fmt.State, verb rune)
type Group
- func (g *Group) Go(fn func(ctx context.Context) error)
- func (g *Group) Wait() error
type StackTrace
- func (st StackTrace) Format(s fmt.State, verb rune)

Constants ¶

View Source

const (
	ModuleDefault = "default"
	ModuleProto   = "protogen"
	ModuleConf    = "confgen"
)

View Source

const (
	// Drives Desc.Stringify rendering; values: default, proto, conf.
	KeyModule = "Module"

	KeyIndir            = "Indir"            // input dir
	KeySubdir           = "Subdir"           // input subdir
	KeyOutdir           = "Outdir"           // output dir
	KeyBookName         = "BookName"         // workbook name
	KeyPrimaryBookName  = "PrimaryBookName"  // primary workbook name
	KeySheetName        = "SheetName"        // worksheet name
	KeyPrimarySheetName = "PrimarySheetName" // primary worksheet name
	KeyNameCellPos      = "NameCellPos"      // name cell position
	KeyNameCell         = "NameCell"         // name cell value
	KeyTrimmedNameCell  = "TrimmedNameCell"  // trimmed name cell value
	KeyTypeCellPos      = "TypeCellPos"      // type cell position
	KeyTypeCell         = "TypeCell"         // type cell value
	KeyNoteCellPos      = "NoteCellPos"      // note cell position
	KeyNoteCell         = "NoteCell"         // note cell value
	KeyDataCellPos      = "DataCellPos"      // data cell position
	KeyDataCell         = "DataCell"         // data data value

	KeyPBMessage   = "PBMessage"   // protobuf message name
	KeyPBFieldName = "PBFieldName" // protobuf message field name
	KeyPBFieldType = "PBFieldType" // protobuf message field type
	KeyPBFieldOpts = "PBFieldOpts" // protobuf message field options (extensions)
	KeyColumnName  = "ColumnName"  // column name

	KeyReason = "Reason" // error reason

)

desc keys

Variables ¶

View Source

var ErrE0001 = newEcode("E0001", `sheet not found in book`)

View Source

var ErrE0002 = newEcode("E0002", `cannot unmarshal file content to given proto.Message`)

View Source

var ErrE0003 = newEcode("E0003", `duplicate column name`)

View Source

var ErrE2000 = newEcode("E2000", `integer overflow`)

View Source

var ErrE2001 = newEcode("E2001", `field prop "refer" not configured correctly`)

View Source

var ErrE2002 = newEcode("E2002", `field value not in referred space`)

View Source

var ErrE2003 = newEcode("E2003", `illegal sequence number`)

View Source

var ErrE2004 = newEcode("E2004", `value is out of range`)

View Source

var ErrE2005 = newEcode("E2005", `map key not unique`)

View Source

var ErrE2006 = newEcode("E2006", `enum value not defined in enum type`)

View Source

var ErrE2007 = newEcode("E2007", `invalid datetime format`)

View Source

var ErrE2008 = newEcode("E2008", `invalid duration format`)

View Source

var ErrE2009 = newEcode("E2009", `duplicate key exists in different sheets`)

View Source

var ErrE2010 = newEcode("E2010", `union type has no corresponding value field`)

View Source

var ErrE2011 = newEcode("E2011", `field presence required but cell not filled`)

View Source

var ErrE2012 = newEcode("E2012", `invalid syntax of numerical value`)

View Source

var ErrE2013 = newEcode("E2013", `invalid syntax of boolean value`)

View Source

var ErrE2014 = newEcode("E2014", `sheet column not found`)

View Source

var ErrE2015 = newEcode("E2015", `referred sheet column not found`)

View Source

var ErrE2016 = newEcode("E2016", `list elements are not present continuously`)

View Source

var ErrE2017 = newEcode("E2017", `map contains multiple empty keys`)

View Source

var ErrE2018 = newEcode("E2018", `map key not exists`)

View Source

var ErrE2019 = newEcode("E2019", `invalid fraction pattern`)

View Source

var ErrE2020 = newEcode("E2020", `invalid comparator pattern`)

View Source

var ErrE2021 = newEcode("E2021", `duplicate enum value alias`)

View Source

var ErrE2022 = newEcode("E2022", `sub-field's value not unique in map values or list elements`)

View Source

var ErrE2023 = newEcode("E2023", `field value conflict across rows or columns`)

View Source

var ErrE2024 = newEcode("E2024", `invalid version pattern`)

View Source

var ErrE2025 = newEcode("E2025", `version value mismatches pattern`)

View Source

var ErrE2026 = newEcode("E2026", `illegally ordered values`)

View Source

var ErrE2027 = newEcode("E2027", `protovalidate violation`)

View Source

var ErrE2028 = newEcode("E2028", `duplicate elements in incell keyed-list`)

View Source

var ErrE3000 = newEcode("E3000", `no workbook file found about sheet specifier`)

View Source

var ErrE3001 = newEcode("E3001", `no worksheet found in workbook`)

View Source

var ErrE3002 = newEcode("E3002", `failed to open file`)

View Source

var ErrE3003 = newEcode("E3003", `CSV workbook glob pattern matches no files`)

Functions ¶

func E0002 ¶

func E0002(filename string, messageName string, error_ error, lines string) error

E0002: cannot unmarshal file content to given proto.Message

func E2001 ¶

func E2001(refer string, messageName string) error

E2001: field prop "refer" not configured correctly

func E2006 ¶

func E2006(value any, enumName any) error

E2006: enum value not defined in enum type

func E2009 ¶

func E2009(key any, fieldName string) error

E2009: duplicate key exists in different sheets

func E2010 ¶

func E2010(typeValue any, fieldNumber any) error

E2010: union type has no corresponding value field

func E2011 ¶

func E2011() error

E2011: field presence required but cell not filled

func E2016 ¶

func E2016(firstNonePresentIndex int, nextPresentIndex int) error

E2016: list elements are not present continuously

func E2022 ¶

func E2022(fieldName string, key any) error

E2022: sub-field's value not unique in map values or list elements

func E2023 ¶

func E2023(currValue any, prevValue any) error

E2023: field value conflict across rows or columns

func E2028 ¶

func E2028(elem any) error

E2028: duplicate elements in incell keyed-list

func E3000 ¶

func E3000(sheetSpecifier string, pattern string) error

E3000: no workbook file found about sheet specifier

func E3003 ¶

func E3003(glob string) error

E3003: CSV workbook glob pattern matches no files

func New ¶

func New(msg string) error

New returns a new error with msg and a stack trace.

func NewKV ¶

func NewKV(msg string, keysAndValues ...any) error

NewKV returns an error with msg, structured key-value fields, and a stack trace.

func Newf ¶

func Newf(format string, args ...any) error

Newf returns a formatted error with a stack trace.

func Wrap ¶

func Wrap(err error) error

Wrap annotates err with a stack trace. Returns nil if err is nil.

func WrapKV ¶

func WrapKV(err error, keysAndValues ...any) error

WrapKV wraps err with structured key-value fields (visible via NewDesc, not in Error()) and a stack trace. Returns nil if err is nil.

func Wrapf ¶

func Wrapf(err error, format string, args ...any) error

Wrapf annotates err with a formatted message and a stack trace. Returns nil if err is nil.

Types ¶

type Collector ¶

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

Collector accumulates errors concurrently up to a configurable limit. Collectors form a hierarchy via Collector.NewChild; Collector.Join recursively merges own errors with children's.

When a child's [collected] error is wrapped (e.g. via WrapKV), the outer [withMessage] is remembered and re-applied in Collector.Join, producing: collected → withMessage{fields} → joinError{…}.

func NewCollector ¶

func NewCollector(maxErrs int) *Collector

NewCollector creates a root Collector. maxErrs: <=0 unlimited, 1 fail-fast, >1 stops after N errors.

func (*Collector) Collect ¶

func (c *Collector) Collect(err error) error

Collect accumulates err into the collector.

nil err: no-op unless this collector (or an ancestor) is already full, in which case the joined error tree is returned immediately.
already-collected err (*collected): records the outer WrapKV layer for re-wrapping in Join; does not increment any counter.
ordinary err: increments every ancestor's counter, stores the error if it is within every ancestor's budget, and returns the joined error tree if any ancestor has now reached its limit (nil otherwise).

func (*Collector) HasErrors ¶

func (c *Collector) HasErrors() bool

HasErrors reports whether this collector's subtree has any errors. It is a fast, lock-free check suitable for guarding expensive Collector.Join calls.

func (*Collector) IsFull ¶

func (c *Collector) IsFull() bool

IsFull reports whether this collector or any ancestor has reached its limit.

func (*Collector) Join ¶

func (c *Collector) Join() error

Join returns all errors in this collector's subtree as a single error.

func (*Collector) NewChild ¶

func (c *Collector) NewChild(maxErrs int) *Collector

NewChild creates a child collector registered under the receiver. maxErrs semantics are the same as NewCollector.

func (*Collector) NewGroup ¶

func (c *Collector) NewGroup(ctx context.Context) *Group

NewGroup returns a new Group backed by this Collector.

type Desc ¶

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

Desc holds structured fields extracted from an error chain. For joined multi-errors, children holds one *Desc per child.

func NewDesc ¶

func NewDesc(err error) *Desc

NewDesc builds a *Desc from err. Single-chain wrappers are traversed to find inner multi-errors; all nested joins are fully flattened with outer fields (e.g. Module, BookName) merged in (innermost wins). Returns nil for nil err.

func (*Desc) GetValue ¶

func (d *Desc) GetValue(key string) any

GetValue returns the field value for key, or nil if absent.

func (*Desc) String ¶

func (d *Desc) String() string

String renders the description without debug info.

func (*Desc) Stringify ¶

func (d *Desc) Stringify(withDebug bool) string

Stringify renders the description. When withDebug is true, each error also includes its structured fields and stack trace. Joined multi-errors are rendered as a numbered list.

type Frame ¶

type Frame uintptr

Frame represents a program counter inside a stack frame. For historical reasons if Frame is interpreted as a uintptr its value represents the program counter + 1.

func (Frame) Format ¶

func (f Frame) Format(s fmt.State, verb rune)

Format formats the frame according to the fmt.Formatter interface.

%s    source file
%d    source line
%n    function name
%v    equivalent to %s:%d

Format accepts flags that alter the printing of some verbs, as follows:

%+s   function name and path of source file relative to the compile time
      GOPATH separated by \n\t (<funcname>\n\t<path>)
%+v   equivalent to %+s:%d

type Group ¶

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

Group ties an errgroup.Group to a Collector for concurrent collection. Context is cancelled when the collector becomes full.

func (*Group) Go ¶

func (g *Group) Go(fn func(ctx context.Context) error)

Go runs fn in a goroutine and collects its error.

func (*Group) Wait ¶

func (g *Group) Wait() error

Wait blocks until all goroutines finish and returns the joined errors.

type StackTrace ¶

type StackTrace []Frame

StackTrace is stack of Frames from innermost (newest) to outermost (oldest).

func (StackTrace) Format ¶

func (st StackTrace) Format(s fmt.State, verb rune)

Format formats the stack of Frames according to the fmt.Formatter interface.

%s	lists source files for each Frame in the stack
%v	lists the source file and line number for each Frame in the stack

Format accepts flags that alter the printing of some verbs, as follows:

%+v   Prints filename, function, and line number for each Frame in the stack.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func E0001 ¶

func E0002 ¶

func E0003 ¶

func E2000 ¶

func E2001 ¶

func E2002 ¶

func E2003 ¶

func E2004 ¶

func E2005 ¶

func E2006 ¶

func E2007 ¶

func E2008 ¶

func E2009 ¶

func E2010 ¶

func E2011 ¶

func E2012 ¶

func E2013 ¶

func E2014 ¶

func E2015 ¶

func E2016 ¶

func E2017 ¶

func E2018 ¶

func E2019 ¶

func E2020 ¶

func E2021 ¶

func E2022 ¶

func E2023 ¶

func E2024 ¶

func E2025 ¶

func E2026 ¶

func E2027 ¶

func E2028 ¶

func E3000 ¶

func E3001 ¶

func E3002 ¶

func E3003 ¶

func New ¶

func NewKV ¶

func Newf ¶

func Wrap ¶

func WrapKV ¶

func Wrapf ¶

Types ¶

type Collector ¶

func NewCollector ¶

func (*Collector) Collect ¶

func (*Collector) HasErrors ¶

func (*Collector) IsFull ¶

func (*Collector) Join ¶

func (*Collector) NewChild ¶

func (*Collector) NewGroup ¶

type Desc ¶

func NewDesc ¶

func (*Desc) GetValue ¶

func (*Desc) String ¶

func (*Desc) Stringify ¶

type Frame ¶

func (Frame) Format ¶

type Group ¶

func (*Group) Go ¶

func (*Group) Wait ¶

type StackTrace ¶

func (StackTrace) Format ¶

Source Files ¶