comdef

Documentation

Overview

Package comdef provide some common type or constant definitions

Index

• Constants
• Variables
• type BaseFormatter
  • func (f *BaseFormatter) BsWriter() ByteStringWriter
  • func (f *BaseFormatter) Reset()
  • func (f *BaseFormatter) SetOutput(out io.Writer)
• type ByteStringWriter
• type DataFormatter
• type Float
• type Int
• type IntOrFloat
• type MarshalFunc
• type ScalarType
• type StringWriteStringer
• type Uint
• type UnmarshalFunc
• type Xint
• type XintOrFloat

Constants

const (
	OpEq  = "="
	OpNeq = "!="
	OpLt  = "<"
	OpLte = "<="
	OpGt  = ">"
	OpGte = ">="
)

consts for compare operation

const (
	SingleQuote = '\''
	DoubleQuote = '"'
	SlashQuote  = '\\'

	SingleQuoteStr = "'"
	DoubleQuoteStr = `"`
	SlashQuoteStr  = "\\"
)

consts quote chars

const (
	// CommaStr const define
	CommaStr = ","
	// CommaChar define
	CommaChar = ','

	// EqualStr define
	EqualStr = "="
	// EqualChar define
	EqualChar = '='

	// ColonStr define
	ColonStr = ":"
	// ColonChar define
	ColonChar = ':'

	// SemicolonStr semicolon define
	SemicolonStr = ";"
	// SemicolonChar define
	SemicolonChar = ';'

	// PathStr define const
	PathStr = "/"
	// PathChar define
	PathChar = '/'

	// DefaultSep comma string
	DefaultSep = ","

	// SpaceChar char
	SpaceChar = ' '
	// SpaceStr string
	SpaceStr = " "

	// NewlineChar char
	NewlineChar = '\n'
	// NewlineStr string
	NewlineStr = "\n"
)

const NoIdx = -1

NoIdx invalid index or length

Variables

var ErrConvType = errors.New("convert value type error")

ErrConvType error

Types

type BaseFormatter

type BaseFormatter struct {

	// Out formatted to the writer
	Out io.Writer
	// Src data(array, map, struct) for format
	Src any
	// MaxDepth limit depth for array, map data TODO
	MaxDepth int
	// Prefix string for each element
	Prefix string
	// Indent string for format each element
	Indent string
	// ClosePrefix string for last "]", "}"
	ClosePrefix string
	// contains filtered or unexported fields
}

BaseFormatter struct

func (*BaseFormatter) BsWriter

func (f *BaseFormatter) BsWriter() ByteStringWriter

BsWriter build and get

func (*BaseFormatter) Reset

func (f *BaseFormatter) Reset()

Reset after format

func (*BaseFormatter) SetOutput

func (f *BaseFormatter) SetOutput(out io.Writer)

SetOutput writer

type ByteStringWriter

type ByteStringWriter interface {
	io.Writer
	io.ByteWriter
	io.StringWriter
	fmt.Stringer
}

ByteStringWriter interface

type DataFormatter

type DataFormatter interface {
	Format() string
	FormatTo(w io.Writer)
}

DataFormatter interface

type Float

type Float interface {
	~float32 | ~float64
}

Float interface type

type Int

type Int interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64
}

Int interface type

type IntOrFloat

type IntOrFloat interface {
	Int | Float
}

IntOrFloat interface type. all int and float types

type MarshalFunc

type MarshalFunc func(v any) ([]byte, error)

MarshalFunc define

type ScalarType

type ScalarType interface {
	Int | Uint | Float | ~string | ~bool
}

ScalarType interface type.

contains: (x)int, float, ~string, ~bool types

type StringWriteStringer

type StringWriteStringer interface {
	io.StringWriter
	fmt.Stringer
}

StringWriteStringer interface

type Uint

type Uint interface {
	~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64
}

Uint interface type

type UnmarshalFunc

type UnmarshalFunc func(bts []byte, ptr any) error

UnmarshalFunc define

type Xint

type Xint interface {
	// equal: ~int | ~int8 | ~int16 | ~int32 | ~int64 | ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint32 | ~uint64
	Int | Uint
}

Xint interface type. all int or uint types

type XintOrFloat

type XintOrFloat interface {
	Int | Uint | Float
}

XintOrFloat interface type. all (x)int and float types