cbtrc

package

v0.6.0 Latest Latest Go to latest Published: Dec 10, 2016 License: Apache-2.0 Imports: 8 Imported by: 0

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 ¶ added in v0.5.0

type RequiredFlags uint

const (
	ProjectRequired RequiredFlags = 1 << iota
	InstanceRequired
)

const NoneRequired RequiredFlags = 0

const ProjectAndInstanceRequired RequiredFlags = ProjectRequired & InstanceRequired

Source Files ¶

cbtrc.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL