settings

Documentation

Index

• func Exists() (bool, error)
• func Remove() error
• func Reset() error
• func SavePath() (string, error)
• func Write() error
• type Data
• type Settings
  • func Load() (*Settings, error)
  • func NewSettingsWithDefaults() Settings
  • func Read() (*Settings, error)
  • func (s Settings) ToYAML() ([]byte, error)

Functions

func Exists

func Exists() (bool, error)

Exists test if any settings file exists

func Remove

func Remove() error

Remove will completely remove a settings file

func Reset

func Reset() error

Reset will reinitialize the settings var with the defaults, useful for debugging or completely resetting customized settings and here to be called from the cli to reset a user's workstation

func SavePath

func SavePath() (string, error)

SavePath is a helper for setting up the user's home path

func Write

func Write() error

Write will write a settings structure to the default file save location

Types

type Data

type Data struct {
	Token string `yaml:"token"`
	URL   string `yaml:"url"`
}

Data is the settings entry which holds settings data, currently this is only the current JWT token for making requests

type Settings

type Settings struct {
	Data Data
}

Settings is the container for the cli settings

func Load

func Load() (*Settings, error)

Load will load an existing settings file from the default save location

func NewSettingsWithDefaults

func NewSettingsWithDefaults() Settings

NewSettingsWithDefaults returns a settings object with data defaults set, primarily to encapsulate defaults that can be over-ridden by those in the know via btck settings set-url --key=value

func Read

func Read() (*Settings, error)

Read will read the settings from the settings path

func (Settings) ToYAML

func (s Settings) ToYAML() ([]byte, error)

ToYAML returns the settings serialized back as it's saved YAML format, primarily for printing to stdout