package comdef

Import Path
	github.com/gookit/goutil/comdef (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 4 packages

Involved Source Files

	  d comdef.go
		Package comdef provide some common type or constant definitions

	    consts.go
	    consts_nonwin.go
	    errors.go
	    formatter.go
	    interface.go
	    serializer.go
	    symbols.go
	    types.go
Package-Level Type Names (total 42)

	/* sort by: alphabet | popularity */
	 type Align uint8 (basic type)
		Align define align, position: L, C, R, Auto

		As Inputs Of (at least 4)
			func github.com/gookit/goutil/strutil.Align(s string, length int, align Align) string
			func github.com/gookit/goutil/strutil.Resize(s string, length int, align Align) string
			func github.com/gookit/goutil/strutil.Utf8Align(s string, length int, align Align) string
			func github.com/gookit/goutil/strutil.Utf8Resize(s string, length int, align Align) string
		As Types Of (total 8)
			const Center
			const Left
			const PosAuto
			const Right
			const github.com/gookit/goutil/strutil.PosAuto
			const github.com/gookit/goutil/strutil.PosLeft
			const github.com/gookit/goutil/strutil.PosMiddle
			const github.com/gookit/goutil/strutil.PosRight

	 type AnyMap (map)
		AnyMap is alias of map[string]any

	 type BaseFormatter (struct)
		BaseFormatter struct
		
		Usage:
		
			 type YourFormatter struct {
					comdef.BaseFormatter
			 }
			 // implement the DataFormatter interface...

		Fields (total 6)
			ClosePrefix string
				ClosePrefix string for last "]", "}"

			Indent string
				Indent string for format each element

			MaxDepth int
				MaxDepth limit depth for array, map data TODO

			Out io.Writer
				Out formatted to the writer

			Prefix string
				Prefix string for each element

			Src any
				Src data(array, map, struct) for format

		Methods (total 3)
			(*BaseFormatter) BsWriter() ByteStringWriter
				BsWriter warp the Out, build a ByteStringWriter

			(*BaseFormatter) Reset()
				Reset after format

			(*BaseFormatter) SetOutput(out io.Writer)
				SetOutput writer


	 type ByteStringWriter (interface)
		ByteStringWriter interface

		Methods (total 4)
			( ByteStringWriter) String() string
			( ByteStringWriter) Write([]byte) (int, error)
			( ByteStringWriter) WriteByte(c byte) error
			( ByteStringWriter) WriteString(s string) (n int, err error)
		Implemented By (at least 8)
			*github.com/gookit/goutil/byteutil.Buffer
			*github.com/gookit/goutil/x/stdio.WriteWrapper
			 github.com/apache/thrift/lib/go/thrift.TMemoryBuffer
			*github.com/libp2p/go-buffer-pool.Buffer
			*bytes.Buffer
			*go.uber.org/zap/buffer.Buffer
			*log/slog/internal/buffer.Buffer
			*strings.Builder
		Implements (at least 10)
			 ByteStringWriter : StringWriteStringer
			 ByteStringWriter : github.com/miekg/dns.Writer
			 ByteStringWriter : github.com/quic-go/quic-go/quicvarint.Writer
			 ByteStringWriter : expvar.Var
			 ByteStringWriter : fmt.Stringer
			 ByteStringWriter : gorm.io/gorm/clause.Writer
			 ByteStringWriter : internal/bisect.Writer
			 ByteStringWriter : io.ByteWriter
			 ByteStringWriter : io.StringWriter
			 ByteStringWriter : io.Writer
		As Outputs Of (at least one exported)
			func (*BaseFormatter).BsWriter() ByteStringWriter

	 type Codec (interface)
		Codec interface definition

		Methods (total 2)
			( Codec) Decode(blob []byte, v any) (err error)
			( Codec) Encode(v any) (out []byte, err error)

	 type Compared (interface)
		Compared type. alias of constraints.SortedType
		
		TODO: use type alias, will error on go1.18 Error: types.go:50: interface contains type constraints
		type Compared = SortedType

	 type DataFormatter (interface)
		DataFormatter interface

		Methods (total 2)
			( DataFormatter) Format() string
			( DataFormatter) FormatTo(w io.Writer)

	 type Errors ([])
		Errors multi error list

		Methods (total 3)
			( Errors) ErrOrNil() error
				ErrOrNil error

			( Errors) Error() string
				Error string

			( Errors) First() error
				First error

		Implements (at least one exported)
			 Errors : error

	 type Float (interface)
		Float interface type

	 type Float64able (interface)
		Float64able interface

		Methods (only one)
			( Float64able) Float64() (float64, error)
		Implemented By (at least 4)
			 github.com/json-iterator/go.Number
			*github.com/redis/go-redis/v9.Cmd
			*github.com/redis/go-redis/v9.StringCmd
			 encoding/json.Number

	 type GoSerializer (interface)
		GoSerializer interface definition

		Methods (total 2)
			( GoSerializer) Marshal(v any) ([]byte, error)
			( GoSerializer) Unmarshal(v []byte, ptr any) error
		Implemented By (at least 9)
			 github.com/google/flatbuffers/go.FlatbuffersCodec
			*github.com/grpc-ecosystem/grpc-gateway/v2/runtime.HTTPBodyMarshaler
			*github.com/grpc-ecosystem/grpc-gateway/v2/runtime.JSONBuiltin
			*github.com/grpc-ecosystem/grpc-gateway/v2/runtime.JSONPb
			 github.com/grpc-ecosystem/grpc-gateway/v2/runtime.Marshaler (interface)
			*github.com/grpc-ecosystem/grpc-gateway/v2/runtime.ProtoMarshaller
			 github.com/json-iterator/go.API (interface)
			 google.golang.org/grpc.Codec (interface)
			 google.golang.org/grpc/encoding.Codec (interface)

	 type Int (interface)
		Int interface type

	 type Int64able (interface)
		Int64able interface

		Methods (only one)
			( Int64able) Int64() (int64, error)
		Implemented By (at least 4)
			 github.com/json-iterator/go.Number
			*github.com/redis/go-redis/v9.Cmd
			*github.com/redis/go-redis/v9.StringCmd
			 encoding/json.Number

	 type IntCheckFunc (func)
		IntCheckFunc check func

	 type Integer (interface)
		Integer interface type. all int or uint types

	 type IntOrFloat (interface)
		IntOrFloat interface type. all int and float types, but NOT uint types

	 type L2StrMap (map)
		L2StrMap is alias of map[string]map[string]string

	 type MapFunc (func)
		MapFunc definition

	 type MarshalFunc (func)
		MarshalFunc define

	 type Matcher[T] (interface)

		Type Parameters:
			T: any

		Matcher interface

		Methods (only one)
			( Matcher[T]) Match(s T) bool

	 type MatchFunc[T] (func)

		Type Parameters:
			T: any

		MatchFunc definition. implements Matcher interface

		Methods (only one)
			( MatchFunc[T]) Match(v T) bool
				Match satisfies the Matcher interface


	 type Number (interface)
		Number interface type. contains all int, uint and float types

	 type NumberOrString (interface)
		NumberOrString interface type for (x)int, float, ~string types

	 type Position = Align (basic type)
	 type SafeStringFunc (func)
		SafeStringFunc safe convert value to string

	 type ScalarType (interface)
		ScalarType basic interface type.
		
		TIP: has bool type, it cannot be ordered
		
		contains: (x)int, float, ~string, ~bool types

	 type Serializer (interface)
		Serializer interface definition

		Methods (total 2)
			( Serializer) Deserialize(data []byte, v any) error
			( Serializer) Serialize(v any) ([]byte, error)

	 type SimpleType (interface)
		SimpleType interface type. alias of ScalarType
		
		contains: (x)int, float, ~string, ~bool types

	 type SortedType (interface)
		SortedType interface type. same of constraints.Ordered
		
		it can be ordered, that supports the operators < <= >= >.
		
		contains: (x)int, float, ~string types

	 type StrCheckFunc (func)
		StrCheckFunc check func

	 type StringHandleFunc (func)
		StringHandleFunc definition

		Methods (only one)
			( StringHandleFunc) Handle(s string) string
				Handle satisfies the StringHandler interface

		Implements (at least one exported)
			 StringHandleFunc : StringHandler
		As Inputs Of (at least one exported)
			func github.com/gookit/goutil/strutil.OrHandle(s string, fn StringHandleFunc) string

	 type StringHandler (interface)
		StringHandler interface

		Methods (only one)
			( StringHandler) Handle(s string) string
		Implemented By (at least one exported)
			 StringHandleFunc

	 type StringMatcher (interface)
		StringMatcher interface

		Methods (only one)
			( StringMatcher) Match(s string) bool
		Implemented By (at least 2)
			 StringMatchFunc
			*github.com/miekg/dns.NSEC3

	 type StringMatchFunc (func)
		StringMatchFunc definition

		Methods (only one)
			( StringMatchFunc) Match(s string) bool
				Match satisfies the StringMatcher interface

		Implements (at least one exported)
			 StringMatchFunc : StringMatcher

	 type StringWriteStringer (interface)
		StringWriteStringer interface

		Methods (total 2)
			( StringWriteStringer) String() string
			( StringWriteStringer) WriteString(s string) (n int, err error)
		Implemented By (at least 9)
			 ByteStringWriter (interface)
			*github.com/gookit/goutil/byteutil.Buffer
			*github.com/gookit/goutil/x/stdio.WriteWrapper
			 github.com/apache/thrift/lib/go/thrift.TMemoryBuffer
			*github.com/libp2p/go-buffer-pool.Buffer
			*bytes.Buffer
			*go.uber.org/zap/buffer.Buffer
			*log/slog/internal/buffer.Buffer
			*strings.Builder
		Implements (at least 3)
			 StringWriteStringer : expvar.Var
			 StringWriteStringer : fmt.Stringer
			 StringWriteStringer : io.StringWriter

	 type StrMap (map)
		StrMap is alias of map[string]string

	 type ToStringFunc (func)
		ToStringFunc try to convert value to string, return error on fail

		As Inputs Of (at least one exported)
			func github.com/gookit/goutil/internal/comfunc.WithUserConvFn(fn ToStringFunc) comfunc.ConvOptionFn

	 type ToTypeFunc[T] (func)

		Type Parameters:
			T: any

		ToTypeFunc convert value to defined type

	 type Uint (interface)
		Uint interface type

	 type UnmarshalFunc (func)
		UnmarshalFunc define

	 type Xint (interface)
		Xint interface type. alias of Integer

	 type XintOrFloat (interface)
		XintOrFloat interface type. all int, uint and float types. alias of Number
		
		Deprecated: use Number instead.


Package-Level Variables (only one)

	  var ErrConvType error
		ErrConvType error


Package-Level Constants (total 33)

	const Center Align = 1
		constants for align, position: L, C, R, Auto

	const ColonChar = 58
		ColonChar define

	const ColonStr = ":"
		ColonStr define

	const CommaChar = 44
		CommaChar define

	const CommaStr = ","
		CommaStr const define

	const DefaultSep = ","
		DefaultSep comma string

	const DoubleQuote = 34
		constants quote chars

	const DoubleQuoteStr = "\""
		constants quote chars

	const EqualChar = 61
		EqualChar define

	const EqualStr = "="
		EqualStr define

	const Left Align = 0
		constants for align, position: L, C, R, Auto

	const Newline = "\n"
		Newline string for non-windows

	const NewlineChar = 10
		NewlineChar char

	const NewlineStr = "\n"
		NewlineStr string

	const NoIdx = -1
		NoIdx invalid index or length

	const OpEq = "="
		constants for compare operation

	const OpGt = ">"
		constants for compare operation

	const OpGte = ">="
		constants for compare operation

	const OpLt = "<"
		constants for compare operation

	const OpLte = "<="
		constants for compare operation

	const OpNeq = "!="
		constants for compare operation

	const PathChar = 47
		PathChar define

	const PathStr = "/"
		PathStr define const

	const PosAuto Align = 3
		constants for align, position: L, C, R, Auto

	const Right Align = 2
		constants for align, position: L, C, R, Auto

	const SemicolonChar = 59
		SemicolonChar define

	const SemicolonStr = ";"
		SemicolonStr semicolon define

	const SingleQuote = 39
		constants quote chars

	const SingleQuoteStr = "'"
		constants quote chars

	const SlashQuote = 92
		constants quote chars

	const SlashQuoteStr = "\\"
		constants quote chars

	const SpaceChar = 32
		SpaceChar char

	const SpaceStr = " "
		SpaceStr string

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.