osx

Documentation

Index

• func GetenvDefault(key string, def string) string
• func ReadFileFromAllSources(source string, opts ...Option) (bytes []byte, err error)
• func RestrictedReadFile(source string, opts ...Option) (bytes []byte, err error)
• type Option
  • func WithBase64Encoding(enc *base64.Encoding) Option
  • func WithDisabledBase64Loader() Option
  • func WithDisabledFileLoader() Option
  • func WithDisabledHTTPLoader() Option
  • func WithEnabledBase64Loader() Option
  • func WithEnabledFileLoader() Option
  • func WithEnabledHTTPLoader() Option
  • func WithHTTPClient(hc *retryablehttp.Client) Option
  • func WithoutResilientBase64Encoding() Option

Functions

func GetenvDefault

func GetenvDefault(key string, def string) string

GetenvDefault returns an environment variable or the default value if it is empty.

func ReadFileFromAllSources

func ReadFileFromAllSources(source string, opts ...Option) (bytes []byte, err error)

ReadFileFromAllSources reads a file from base64, http, https, and file sources.

Using options, you can disable individual loaders. For example, the following will return an error:

ReadFileFromAllSources("https://foo.bar/baz.txt", WithDisabledHTTPLoader())

Possible formats are:

- /path/to/file - file:///path/to/file - https://host.com/path/to/file - http://host.com/path/to/file - base64://<base64 encoded string>

For more options, check:

- WithDisabledFileLoader - WithDisabledHTTPLoader - WithDisabledBase64Loader - WithBase64Encoding - WithHTTPClient

func RestrictedReadFile

func RestrictedReadFile(source string, opts ...Option) (bytes []byte, err error)

RestrictedReadFile works similar to ReadFileFromAllSources but has all sources disabled per default. You need to enable the loaders you wish to use explicitly.

Types

type Option

type Option func(o *options)

func WithBase64Encoding

func WithBase64Encoding(enc *base64.Encoding) Option

WithBase64Encoding sets the base64 encoding.

func WithDisabledBase64Loader

func WithDisabledBase64Loader() Option

WithDisabledBase64Loader disables the base64 loader.

func WithDisabledFileLoader

func WithDisabledFileLoader() Option

WithDisabledFileLoader disables the file loader.

func WithDisabledHTTPLoader

func WithDisabledHTTPLoader() Option

WithDisabledHTTPLoader disables the HTTP loader.

func WithEnabledBase64Loader

func WithEnabledBase64Loader() Option

WithEnabledBase64Loader disables the base64 loader.

func WithEnabledFileLoader

func WithEnabledFileLoader() Option

WithEnabledFileLoader enables the file loader.

func WithEnabledHTTPLoader

func WithEnabledHTTPLoader() Option

WithEnabledHTTPLoader enables the HTTP loader.

func WithHTTPClient

func WithHTTPClient(hc *retryablehttp.Client) Option

WithHTTPClient sets the HTTP client.

func WithoutResilientBase64Encoding

func WithoutResilientBase64Encoding() Option

WithoutResilientBase64Encoding sets the base64 encoding.