kit

Documentation

Index

• type Error
  • func ConvertError(f *fs.File, err any) Error
• type JSchemaError
  • func NewJSchemaError(file *fs.File, e *errs.Err) JSchemaError
  • func (e JSchemaError) Code() errs.Code
  • func (e JSchemaError) Column() uint
  • func (e JSchemaError) ErrCode() int
  • func (e JSchemaError) Error() string
  • func (e JSchemaError) Filename() string
  • func (e JSchemaError) IncorrectUserType() string
  • func (e JSchemaError) Index() uint
  • func (e JSchemaError) Line() uint
  • func (e JSchemaError) Message() string
  • func (e *JSchemaError) SetFile(file *fs.File)
  • func (e *JSchemaError) SetIncorrectUserType(s string)
  • func (e *JSchemaError) SetIndex(index bytes.Index)
  • func (e *JSchemaError) SetMessage(message string)
  • func (e *JSchemaError) SourceSubString() string
  • func (e *JSchemaError) String() string

Types

type Error

type Error interface {
	Filename() string
	Index() uint
	Line() uint
	Column() uint
	Message() string
	ErrCode() int
	IncorrectUserType() string
}

func ConvertError

func ConvertError(f *fs.File, err any) Error

ConvertError converts error to Error interface. Used in JSight API Core.

type JSchemaError

type JSchemaError struct {

	// ObjectKey contains the name of the property of the object where the error was detected
	ObjectKey string
	// contains filtered or unexported fields
}

JSchemaError contains methods for forming a detailed description of the error for a person. The resulting message will contain the filename, line number, and where the error occurred.

func NewJSchemaError

func NewJSchemaError(file *fs.File, e *errs.Err) JSchemaError

func (JSchemaError) Code

func (e JSchemaError) Code() errs.Code

func (JSchemaError) Column

func (e JSchemaError) Column() uint

func (JSchemaError) ErrCode

func (e JSchemaError) ErrCode() int

func (JSchemaError) Error

func (e JSchemaError) Error() string

func (JSchemaError) Filename

func (e JSchemaError) Filename() string

func (JSchemaError) IncorrectUserType

func (e JSchemaError) IncorrectUserType() string

func (JSchemaError) Index

func (e JSchemaError) Index() uint

func (JSchemaError) Line

func (e JSchemaError) Line() uint

Line returns 0 if the line number cannot be determined, or 1+ if it can.

func (JSchemaError) Message

func (e JSchemaError) Message() string

func (*JSchemaError) SetFile

func (e *JSchemaError) SetFile(file *fs.File)

func (*JSchemaError) SetIncorrectUserType

func (e *JSchemaError) SetIncorrectUserType(s string)

func (*JSchemaError) SetIndex

func (e *JSchemaError) SetIndex(index bytes.Index)

func (*JSchemaError) SetMessage

func (e *JSchemaError) SetMessage(message string)

func (*JSchemaError) SourceSubString

func (e *JSchemaError) SourceSubString() string

SourceSubString returns empty string, if cannot determine the source sub-string.

func (*JSchemaError) String

func (e *JSchemaError) String() string