README
¶
go-typedenv
environment variable scanner with type parameter
Documentation
¶
Index ¶
- func Direct[T underlying.Basic](val *T) encoding.TextUnmarshaler
- func Map[T underlying.Basic, U ~map[T]struct{}](val *U, seps ...string) encoding.TextUnmarshaler
- func Scan(scanners ...Scanner) error
- func Slice[T underlying.Basic, U ~[]T](val *U, seps ...string) encoding.TextUnmarshaler
- type Scanner
- func Default(key string, u encoding.TextUnmarshaler, defaultVal string) Scanner
- func DefaultDirect[T underlying.Basic](key string, val *T, defaultVal string) Scanner
- func Lookup(key string, u encoding.TextUnmarshaler) Scanner
- func LookupDirect[T underlying.Basic](key string, val *T) Scanner
- func Required(key string, u encoding.TextUnmarshaler) Scanner
- func RequiredDirect[T underlying.Basic](key string, val *T) Scanner
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Direct ¶
func Direct[T underlying.Basic](val *T) encoding.TextUnmarshaler
Direct returns encoding.TextUnmarshaler implementation for basic types.
func Map ¶
func Map[T underlying.Basic, U ~map[T]struct{}](val *U, seps ...string) encoding.TextUnmarshaler
Map returns encoding.TextUnmarshaler implementation for map.
func Slice ¶
func Slice[T underlying.Basic, U ~[]T](val *U, seps ...string) encoding.TextUnmarshaler
Slice returns encoding.TextUnmarshaler implementation for slice.
Types ¶
type Scanner ¶
type Scanner struct {
// contains filtered or unexported fields
}
Scanner sets some rules to lookup and convert env var.
func Default ¶
func Default(key string, u encoding.TextUnmarshaler, defaultVal string) Scanner
Default returns Scanner with default value. This function requires Converter.
func DefaultDirect ¶
func DefaultDirect[T underlying.Basic](key string, val *T, defaultVal string) Scanner
DefaultDirect returns Scanner with default value.
func Lookup ¶
func Lookup(key string, u encoding.TextUnmarshaler) Scanner
Lookup returns Scanner without required and default. This function requires Converter.
func LookupDirect ¶
func LookupDirect[T underlying.Basic](key string, val *T) Scanner
LookupDirect returns Scanner without required and default.
func Required ¶
func Required(key string, u encoding.TextUnmarshaler) Scanner
Required returns Scanner with required flag. This function requires Converter.
func RequiredDirect ¶
func RequiredDirect[T underlying.Basic](key string, val *T) Scanner
RequiredDirect returns Scanner with required flag.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.