rorconfig

func AutomaticEnv ¶

func AutomaticEnv()

AutomaticEnv loads configuration values from environment variables for all registered string(key)s. This is called internally by InitConfig and typically doesn't need to be called directly.

func ExportToStruct ¶ added in v1.18.2

func ExportToStruct[T any](rc *rorConfigSet) (*T, error)

ExportToStruct creates a new instance of T and populates its fields from the configuration store. Fields must be tagged with `rorconfig:"KEY"` to be populated. Untagged struct fields are recursed into. Supports the same set of types as ImportStruct: string, bool, int*, uint*, float*, time.Time, time.Duration, and pointers to any of these.

func GetBool ¶

func GetBool[K configKey](key K) bool

GetBool retrieves a configuration value as a boolean. Returns true if the value is "true" (case-insensitive), false otherwise.

func GetConfigToStruct ¶ added in v1.18.2

func GetConfigToStruct[T any]() (*T, error)

GetConfigToStruct creates a new instance of T and populates its rorconfig-tagged fields from the configuration store. This is the inverse of SetConfigFromStruct and enables a full round-trip: file → store → struct → file.

func GetConfigs ¶

func GetConfigs() configsMap

GetConfigs returns a copy of all currently loaded configuration values. This is primarily used for debugging and testing purposes.

func GetFloat32 ¶

func GetFloat32[K configKey](key K) float32

GetFloat32 retrieves a configuration value as a 32-bit floating point number. Returns the float32 value, or 0.0 if the value cannot be parsed as a float32.

func GetFloat64 ¶

func GetFloat64[K configKey](key K) float64

GetFloat64 retrieves a configuration value as a 64-bit floating point number. Returns the float64 value, or 0.0 if the value cannot be parsed as a float64.

func GetInt ¶

func GetInt[K configKey](key K) int

GetInt retrieves a configuration value as an integer. Returns the integer value, or 0 if the value cannot be parsed as an integer.

func GetInt64 ¶

func GetInt64[K configKey](key K) int64

GetInt64 retrieves a configuration value as a 64-bit integer. Returns the int64 value, or 0 if the value cannot be parsed as an int64.

func GetString ¶

func GetString[K configKey](key K) string

GetString retrieves a configuration value as a string. Returns the string value of the configuration string(key), or empty string if not set.

func GetTime ¶ added in v1.11.0

func GetTime[K configKey](key K) time.Time

GetTime retrieves a configuration value as a time.Time. Returns the time.Time value, or the zero time if the value cannot be parsed as a time.

func GetTimeDuration ¶ added in v1.11.0

func GetTimeDuration[K configKey](key K) time.Duration

GetTimeDuration retrieves a configuration value as a time.Duration. Returns the time.Duration value, or 0 if the value cannot be parsed as a duration.

func GetUint ¶

func GetUint[K configKey](key K) uint

GetUint retrieves a configuration value as an unsigned integer. Returns the uint value, or 0 if the value cannot be parsed as a uint.

func GetUint32 ¶

func GetUint32[K configKey](key K) uint32

GetUint32 retrieves a configuration value as a 32-bit unsigned integer. Returns the uint32 value, or 0 if the value cannot be parsed as a uint32.

func GetUint64 ¶

func GetUint64[K configKey](key K) uint64

GetUint64 retrieves a configuration value as a 64-bit unsigned integer. Returns the uint64 value, or 0 if the value cannot be parsed as a uint64.

func InitConfig ¶

func InitConfig()

InitConfig initializes the configuration system by automatically loading all recognized environment variables. This should be called once at application startup.

func IsSet ¶

func IsSet[K configKey](key K) bool

IsSet checks if a configuration string(key) has been set (either from environment variable, default value, or explicitly set value). Returns true if the string(key) exists and has a value, false otherwise.

func LoadFromFile ¶ added in v1.18.2

func LoadFromFile[T any](path string) error

LoadFromFile reads a YAML file at the given path, unmarshals it into T (which defines the file schema via yaml tags), and imports the rorconfig-tagged fields into the configuration store with ConfigSourceConfigFile. After loading, values are accessed via the rorconfig.Get* methods.

func SaveToFile ¶ added in v1.18.2

func SaveToFile[T any](path string) error

func Set ¶

func Set[K configKey](key K, value any)

Set explicitly sets a configuration value for the given string(key). This will override any environment variable or default value.

func SetConfigFromStruct ¶ added in v1.11.0

func SetConfigFromStruct(source any) error

SetConfigFromStruct registers configuration values from a struct using the rorconfig tag on each field. Tagged fields are written into the internal configuration map using their tag value as key. Supported field kinds are strings, booleans, integers, unsigned integers, and floats.

func SetDefault ¶

func SetDefault[K configKey](key K, defaultValue any)

SetDefault sets a default value for a configuration string(key). The default value will only be used if no environment variable or explicit value is set.

func SetWithProvider ¶

func SetWithProvider[K configKey](key K, provider SecretProvider)

SetWithProvider sets a configuration value using a custom SecretProvider. The provider's GetSecret() method will be called to retrieve the actual value. This is useful for integrating with external secret management systems.