types

Documentation

Index

• type ArgHelp
• type ArgString
• type ArgTypes
  • func (arg *ArgTypes) String() (result string)
  • func (arg *ArgTypes) Typecheck(value any) (err error)
  • func (arg *ArgTypes) Valid() (result error)

Types

type ArgHelp

type ArgHelp string

ArgHelp - This represents a help string

type ArgString

type ArgString string

ArgString - This the string type in an Argument

type ArgTypes

type ArgTypes uint8

ArgTypes - datatypes interpreted

const (

	// Boolean - Represents a boolean (true/false)
	Boolean ArgTypes = 2

	// Flag - Represents a boolean flag (present - true, absent - false)
	Flag ArgTypes = 4

	// Float - Represents a 64-bit floating-point number
	Float ArgTypes = 3

	// Integer - Represents a 64-bit integer
	Integer ArgTypes = 1

	// String - Represents a string
	String ArgTypes = 0
)

func (*ArgTypes) String

func (arg *ArgTypes) String() (result string)

String - Return a string version of an ArgTypes

func (*ArgTypes) Typecheck

func (arg *ArgTypes) Typecheck(value any) (err error)

Typecheck -type-check the default value

func (*ArgTypes) Valid

func (arg *ArgTypes) Valid() (result error)

Valid - Return true if ArgTypes is valid or false if ArgTypes is not valid.