errordata

Documentation

Overview

Package errordata helps with error serialization.

Index

• type Internal
  • func Deconstruct(err error) *Internal
  • func (x *Internal) GetPublic() *Public
  • func (x *Internal) Reconstruct() error
• type Module
• type Public
  • func (x *Public) Reconstruct() error
• type ResourceLimit

Types

type Internal

type Internal struct {
	Error  string  `json:"error,omitempty"` // Omitted if same as public error.
	Public *Public `json:"public,omitempty"`
}

Internal details of an error.

func Deconstruct

func Deconstruct(err error) *Internal

Deconstruct an error on best-effort basis.

func (*Internal) GetPublic

func (x *Internal) GetPublic() *Public

GetPublic representation which is well-formed even if there are no public details.

func (*Internal) Reconstruct

func (x *Internal) Reconstruct() error

Reconstruct an error.

type Module

type Module struct {
	UnexpectedEOF bool `json:"unexpected_eof,omitempty"`
}

Module error details.

type Public

type Public struct {
	Error         string         `json:"error"`
	Module        *Module        `json:"module,omitempty"`
	ResourceLimit *ResourceLimit `json:"resource_limit,omitempty"`
}

Public details of an error.

func (*Public) Reconstruct

func (x *Public) Reconstruct() error

Reconstruct an error without internal details.

type ResourceLimit

type ResourceLimit struct {
	BufferSizeExceeded bool `json:"buffer_size_exceeded,omitempty"`
}

ResourceLimit error details.