netrc

Documentation

Overview

Package netrc contains functionality to work with netrc.

Index

• Constants
• func DeleteMachineForName(envContainer app.EnvContainer, name string) (bool, error)
• func GetFilePath(envContainer app.EnvContainer) (string, error)
• func PutMachines(envContainer app.EnvContainer, machines ...Machine) error
• type Machine
  • func GetMachineForName(envContainer app.EnvContainer, name string) (_ Machine, retErr error)
  • func GetMachineForNameAndFilePath(name string, filePath string) (_ Machine, retErr error)
  • func NewMachine(name string, login string, password string) Machine

Constants

const Filename = netrcFilename

Filename exposes the netrc filename based on the current operating system.

Functions

func DeleteMachineForName

func DeleteMachineForName(envContainer app.EnvContainer, name string) (bool, error)

DeleteMachineForName deletes the Machine for the given name, if set.

Returns false if there was no Machine for the given name.

func GetFilePath

func GetFilePath(envContainer app.EnvContainer) (string, error)

GetFilePath gets the netrc file path for the given environment.

func PutMachines

func PutMachines(envContainer app.EnvContainer, machines ...Machine) error

PutMachines adds the given Machines to the configured netrc file.

Types

type Machine

type Machine interface {
	// Empty for default machine.
	Name() string
	Login() string
	Password() string
}

Machine is a machine.

func GetMachineForName

func GetMachineForName(envContainer app.EnvContainer, name string) (_ Machine, retErr error)

GetMachineForName returns the Machine for the given name.

Returns nil if no such Machine.

func GetMachineForNameAndFilePath

func GetMachineForNameAndFilePath(name string, filePath string) (_ Machine, retErr error)

GetMachineForNameAndFilePath returns the Machine for the given name from the file at the given path.

Returns nil if no such Machine or no such file.

func NewMachine

func NewMachine(
	name string,
	login string,
	password string,
) Machine

NewMachine creates a new Machine.