dollyerr

package
v0.0.0-...-0f4d910 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2023 License: GPL-3.0 Imports: 2 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Code

type Code uint

Code is spec Code of error

const (
	// CodeNone - null value, no error
	CodeNone Code = iota

	// CodeUndefinedError - undefined generator error Code
	CodeUndefinedError

	// CodeConfigContainsDuplicateCommands - some command is duplicating
	CodeConfigContainsDuplicateCommands

	// CodeConfigContainsDuplicateFlags - some flag is duplicating
	CodeConfigContainsDuplicateFlags

	// CodeConfigDefaultValueIsNotAllowed - some default value is not allowed
	CodeConfigDefaultValueIsNotAllowed

	// CodeConfigFlagIsNotUsedInCommands - some flag is described, but not used in commands descriptions
	CodeConfigFlagIsNotUsedInCommands

	// CodeConfigUndefinedFlag - some flag is undefined in flag description list of yaml config file
	CodeConfigUndefinedFlag

	// CodeConfigIncorrectCharacterInFlagName - flag contain incorrect character in its name
	CodeConfigIncorrectCharacterInFlagName

	// CodeConfigIncorrectFlagLen - some flag has an empty or too long call name
	CodeConfigIncorrectFlagLen

	// CodeConfigFlagMustHaveDashInFront - all flag call names must have a dash in front
	CodeConfigFlagMustHaveDashInFront

	// CodeConfigUnexpectedDefaultValue - this set amount type description "single" if you want to use default values logic
	CodeConfigUnexpectedDefaultValue

	// CodeCantFindFlagNameInGroupSpec - unexpected flag name for determine using flag group
	CodeCantFindFlagNameInGroupSpec

	// CodeFileDecoratorCloseError - file.Close method returned an error
	CodeFileDecoratorCloseError

	// CodeFileDecoratorWriteStringError - file.WriteString returned an error
	CodeFileDecoratorWriteStringError

	// CodeGeneratorInvalidPath - path is not exist
	CodeGeneratorInvalidPath

	// CodeGeneratorCreateDirError - create a dir error
	CodeGeneratorCreateDirError

	// CodeGeneratorCreateFileError - create a file error
	CodeGeneratorCreateFileError

	// CodeGeneratorNoRequiredFlag - get required flag page error
	CodeGeneratorNoRequiredFlag

	// CodeGeneratorWriteFileError - write file error
	CodeGeneratorWriteFileError

	// CodeGetConfigReadFileError - can't read yaml config file
	CodeGetConfigReadFileError

	// CodeGetConfigUnmarshalError - some unmarshal yaml config file error
	CodeGetConfigUnmarshalError

	// CodeHelpDisplayTerminalWidthLimitError - invalid calculated terminal len limit
	CodeHelpDisplayTerminalWidthLimitError

	// CodeHelpDisplayReceiverIsNilPointer - try to call method with nil receiver pointer
	CodeHelpDisplayReceiverIsNilPointer

	// CodeHelpDisplayRunError - something wrong with help page displaying
	CodeHelpDisplayRunError

	// CodeArgParserArgValueIsNotAllowed - arg value is not found in allowed values list
	CodeArgParserArgValueIsNotAllowed

	// CodeArgParserDashInFrontOfArg - argument must not contain dash in front
	CodeArgParserDashInFrontOfArg

	// CodeArgParserCheckValueAllowabilityError - generator error: try to check a value allowability by nil pointer
	CodeArgParserCheckValueAllowabilityError

	// CodeArgParserDuplicateFlags - some flag is duplicating
	CodeArgParserDuplicateFlags

	// CodeArgParserFlagMustHaveArg - some flag doesn't have arg
	CodeArgParserFlagMustHaveArg

	// CodeArgParserIsNotInitialized - looks like Init method was not called or was called with nil CmdArgSpec pointer
	CodeArgParserIsNotInitialized

	// CodeArgParserNamelessCommandUndefined - arguments are not set, but no page about nameless command in config object
	CodeArgParserNamelessCommandUndefined

	// CodeArgParserCommandDoesNotContainArgs - command doesn't contain required args
	CodeArgParserCommandDoesNotContainArgs

	// CodeArgParserRequiredFlagIsNotSet - some required flag is not set
	CodeArgParserRequiredFlagIsNotSet

	// CodeArgParserUnexpectedArg - unexpected command argument is set
	CodeArgParserUnexpectedArg

	// CodeArgParserUnexpectedFlag - unexpected flag
	CodeArgParserUnexpectedFlag

	// CodeOSDecoratorCreateError - file creation error
	CodeOSDecoratorCreateError

	// CodeOSDecoratorMkdirAllError - directory creation error
	CodeOSDecoratorMkdirAllError

	// CodeTermBoxDecoratorInitError - can't init a termbox decorator
	CodeTermBoxDecoratorInitError

	// CodeTermBoxDecoratorFlushError - termbox Flush() method returned an error
	CodeTermBoxDecoratorFlushError

	// CodeTermBoxDecoratorClearError - termbox Clear() method returned an error
	CodeTermBoxDecoratorClearError
)

func (Code) ToUint

func (c Code) ToUint() uint

ToUint converts Code type to uint

type Error

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

Error is detail of parser work error

func Append

func Append(i *Error, err error) *Error

func NewError

func NewError(code Code, err error) *Error

NewError creates Error object

func NewErrorIfItIs

func NewErrorIfItIs(code Code, prefix string, err error) *Error

NewErrorIfItIs creates Error object if err argument is not a nil pointer

func (*Error) Code

func (i *Error) Code() Code

Code returns code of error, you must check if error == nil before

func (*Error) Error

func (i *Error) Error() error

Error decorates standard error interface

Jump to

Keyboard shortcuts

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