file

Documentation

Index

• type OptionsFunc
  • func WithFile(file string) OptionsFunc
  • func WithFs(fs afero.Fs) OptionsFunc
• type ReadPasswordFromFile
  • func NewReadPasswordFromFile(options ...OptionsFunc) *ReadPasswordFromFile
  • func (s *ReadPasswordFromFile) Options(opts ...OptionsFunc)
  • func (s *ReadPasswordFromFile) Read() (string, error)

Types

type OptionsFunc

type OptionsFunc func(*ReadPasswordFromFile)

OptionsFunc is a function used to configure ReadPasswordFromFile

func WithFile

func WithFile(file string) OptionsFunc

WithFile sets the a file where to look for a password

func WithFs

func WithFs(fs afero.Fs) OptionsFunc

WithFs set the filesystem

type ReadPasswordFromFile

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

ReadPasswordFromFile allows you to read a passowrd from a file

func NewReadPasswordFromFile

func NewReadPasswordFromFile(options ...OptionsFunc) *ReadPasswordFromFile

NewReadPasswordFromFile returns a ReadPasswordFromFile

func (*ReadPasswordFromFile) Options

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

Options configure the ReadPasswordFromFile

func (*ReadPasswordFromFile) Read

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

Read returns a password from a file. It return an error when the file does not exist or the content of the file can not be read.