cbtrc

Documentation

Overview

Package cbtrc encapsulates common code for reading .cbtrc files.

Index

• func Filename() string
• type Config
  • func Load() (*Config, error)
  • func (c *Config) CheckFlags(required RequiredFlags) error
  • func (c *Config) RegisterFlags()
• type RequiredFlags

Functions

func Filename

func Filename() string

Filename returns the filename consulted for standard configuration.

Types

type Config

type Config struct {
	Project, Instance string // required
	Creds             string // optional
	AdminEndpoint     string // optional
	DataEndpoint      string // optional
}

Config represents a configuration.

func Load

func Load() (*Config, error)

Load loads a .cbtrc file. If the file is not present, an empty config is returned.

func (*Config) CheckFlags

func (c *Config) CheckFlags(required RequiredFlags) error

CheckFlags checks that the required config values are set.

func (*Config) RegisterFlags

func (c *Config) RegisterFlags()

RegisterFlags registers a set of standard flags for this config. It should be called before flag.Parse.

type RequiredFlags

type RequiredFlags uint

const (
	ProjectRequired RequiredFlags = 1 << iota
	InstanceRequired
)

const NoneRequired RequiredFlags = 0

const ProjectAndInstanceRequired RequiredFlags = ProjectRequired & InstanceRequired