config

package
v0.0.30 Latest Latest
Warning

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

Go to latest
Published: Nov 6, 2025 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Initialized bool
)

Functions

func All

func All() map[string]any

All 获取所有配置项。 返回值是一个包含所有配置键值对的映射。

func GetBool

func GetBool(key string) bool

GetBool 获取布尔类型的配置值。 参数 key 表示要获取的配置项名称。 返回值是对应的布尔值;如果配置未初始化则记录错误日志并返回 false。

func GetDuration added in v0.0.25

func GetDuration(key string) time.Duration

GetDuration 获取时间间隔类型的配置值。 参数 key 表示要获取的配置项名称。 返回值是对应的时间间隔值;如果配置未初始化则记录错误日志并返回 0。

func GetDurationOr added in v0.0.25

func GetDurationOr(key string, def time.Duration) time.Duration

GetDurationOr 获取时间间隔类型的配置值,若不存在或为零值则返回默认值。 参数 key 表示要获取的配置项名称。 参数 def 表示当配置项不存在或为零值时返回的默认值。 返回值是配置值或默认值。

func GetFloat64

func GetFloat64(key string) float64

GetFloat64 获取浮点数类型的配置值。 参数 key 表示要获取的配置项名称。 返回值是对应的 float64 值;如果配置未初始化或出错则记录错误日志并返回 0。

func GetFloat64Or added in v0.0.25

func GetFloat64Or(key string, def float64) float64

GetFloat64Or 获取浮点数类型的配置值,若不存在则返回默认值。 参数 key 表示要获取的配置项名称。 参数 def 表示当配置项不存在时返回的默认值。 返回值是配置值或默认值。

func GetInt

func GetInt(key string) int

GetInt 获取整数类型的配置值。 参数 key 表示要获取的配置项名称。 返回值是对应的整数值;如果配置未初始化或出错则记录错误日志并返回 0。

func GetInt64 added in v0.0.24

func GetInt64(key string) int64

GetInt64 获取 64 位整数类型的配置值。 参数 key 表示要获取的配置项名称。 返回值是对应的 int64 值;如果配置未初始化或出错则记录错误日志并返回 0。

func GetInt64Or added in v0.0.25

func GetInt64Or(key string, def int64) int64

GetInt64Or 获取 64 位整数类型的配置值,若不存在则返回默认值。 参数 key 表示要获取的配置项名称。 参数 def 表示当配置项不存在时返回的默认值。 返回值是配置值或默认值。

func GetIntOr added in v0.0.25

func GetIntOr(key string, def int) int

GetIntOr 获取整数类型的配置值,若不存在则返回默认值。 参数 key 表示要获取的配置项名称。 参数 def 表示当配置项不存在时返回的默认值。 返回值是配置值或默认值。

func GetString

func GetString(key string) string

GetString 获取字符串类型的配置值。 参数 key 表示要获取的配置项名称。 返回值是对应的字符串值;如果配置未初始化或不存在则记录错误日志并返回空字符串。

func GetStringOr added in v0.0.25

func GetStringOr(key, def string) string

GetStringOr 获取字符串类型的配置值,若不存在则返回默认值。 参数 key 表示要获取的配置项名称。 参数 def 表示当配置项不存在时返回的默认值。 返回值是配置值或默认值。

func GetUint64 added in v0.0.24

func GetUint64(key string) uint64

GetUint64 获取无符号 64 位整数类型的配置值。 参数 key 表示要获取的配置项名称。 返回值是对应的 uint64 值;如果配置未初始化或出错则记录错误日志并返回 0。

func GetUint64Or added in v0.0.25

func GetUint64Or(key string, def uint64) uint64

GetUint64Or 获取无符号 64 位整数类型的配置值,若不存在则返回默认值。 参数 key 表示要获取的配置项名称。 参数 def 表示当配置项不存在时返回的默认值。 返回值是配置值或默认值。

func Has added in v0.0.25

func Has(key string) bool

Has 判断指定 key 是否存在于配置中。 参数 key 表示要查询的配置项名称。 返回值表示该配置项是否存在。

func Init

func Init(path string) error

Init 通过指定文件位置初始化配置 参数 path 指定配置文件路径,默认为 "./config.yaml"。

func LoadKey

func LoadKey[T any](key string) (T, error)

LoadKey 从配置中加载指定键的值并将其转换为指定类型 参数 key: 配置键名 返回值 T: 加载的配置值

Types

This section is empty.

Jump to

Keyboard shortcuts

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