types

package

v0.26.0 Latest Latest Go to latest Published: Jun 5, 2026 License: Apache-2.0, BSD-3-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/antgroup/hugescm

Links

Open Source Insights

Documentation ¶

Overview ¶

Package types defines helpers for type conversions.

The API for this package is not finalized yet.

Index ¶

Variables
func ParseBool(s string) (bool, error)
func ParseInt(intptr any, val string, mode IntMode) error
func ScanFully(ptr any, val string, verb byte) error
type EnumParser
- func (ep *EnumParser) AddVals(vals map[string]any)
- func (ep EnumParser) Parse(s string) (any, error)
type IntMode
- func (m IntMode) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrAmbiguousInt    = fmt.Errorf("ambiguous integer value; must include '0' prefix")
	ErrUnsupportedMode = errors.New("unsupported mode")
)

View Source

var BoolValues = map[string]any{
	"true": true, "yes": true, "on": true, "1": true,
	"false": false, "no": false, "off": false, "0": false,
}

BoolValues defines the name and value mappings for ParseBool.

Functions ¶

func ParseBool ¶

func ParseBool(s string) (bool, error)

ParseBool parses bool values according to the definitions in BoolValues. Parsing is case-insensitive.

func ParseInt ¶

func ParseInt(intptr any, val string, mode IntMode) error

ParseInt parses val using mode into intptr, which must be a pointer to an integer kind type. Non-decimal value require prefix `0` or `0x` in the cases when mode permits ambiguity of base; otherwise the prefix can be omitted.

func ScanFully ¶

func ScanFully(ptr any, val string, verb byte) error

ScanFully uses fmt.Sscanf with verb to fully scan val into ptr.

Types ¶

type EnumParser ¶

type EnumParser struct {
	Type      string // type name; if not set, use type of first value added
	CaseMatch bool   // if true, matching of strings is case-sensitive
	// contains filtered or unexported fields
}

EnumParser parses "enum" values; i.e. a predefined set of strings to predefined values.

func (*EnumParser) AddVals ¶

func (ep *EnumParser) AddVals(vals map[string]any)

AddVals adds strings and values to an EnumParser.

func (EnumParser) Parse ¶

func (ep EnumParser) Parse(s string) (any, error)

Parse parses the string and returns the value or an error.

type IntMode ¶

type IntMode uint8

An IntMode is a mode for parsing integer values, representing a set of accepted bases.

const (
	Dec IntMode = 1 << iota
	Hex
	Oct
)

IntMode values for ParseInt; can be combined using binary or.

func (IntMode) String ¶

func (m IntMode) String() string

String returns a string representation of IntMode; e.g. `IntMode(Dec|Hex)`.

Source Files ¶

View all Source files

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