envvars

Documentation

Index

• type OptionsFunc
  • func WithEnvVar(envvar string) OptionsFunc
• type ReadPasswordFromEnvVar
  • func NewReadPasswordFromEnvVar(options ...OptionsFunc) *ReadPasswordFromEnvVar
  • func (s *ReadPasswordFromEnvVar) Options(opts ...OptionsFunc)
  • func (s *ReadPasswordFromEnvVar) Read() (string, error)

Types

type OptionsFunc

type OptionsFunc func(*ReadPasswordFromEnvVar)

OptionsFunc is a function used to configure ReadPasswordFromEnvVar

func WithEnvVar

func WithEnvVar(envvar string) OptionsFunc

WithEnvVar set the environment variable that contains the password defined on it

type ReadPasswordFromEnvVar

type ReadPasswordFromEnvVar struct {
	// contains filtered or unexported fields
}

ReadPasswordFromEnvVar returns a password set in an environment variable

func NewReadPasswordFromEnvVar

func NewReadPasswordFromEnvVar(options ...OptionsFunc) *ReadPasswordFromEnvVar

NewReadPasswordFromEnvVar returns a ReadPasswordFromEnvVar

func (*ReadPasswordFromEnvVar) Options

func (s *ReadPasswordFromEnvVar) Options(opts ...OptionsFunc)

Options configure the ReadPasswordFromEnvVar

func (*ReadPasswordFromEnvVar) Read

func (s *ReadPasswordFromEnvVar) Read() (string, error)

Read returns the password that is set in the environment variable defined on the envvar attribute