options

Documentation

Overview

Package options contains configuration parsing for the nodecmd.

Index

• func Usage(flagset *flag.FlagSet)
• type Options
  • func NewOptions() *Options
  • func (o *Options) BindFlags(fs *flag.FlagSet) *Options
  • func (o *Options) DeepCopy() *Options
  • func (o *Options) Marshal() ([]byte, error)
  • func (o *Options) MarshalTo(w io.Writer) error
  • func (o *Options) Validate() error

Functions

func Usage

func Usage(flagset *flag.FlagSet)

Usage prints the usage of the given flagset.

Types

type Options

type Options struct {
	Global *global.Options `yaml:"global,omitempty" json:"global,omitempty" toml:"global,omitempty" mapstructure:"global,omitempty"`

	Mesh     *mesh.Options       `yaml:",inline" json:",inline" toml:",inline" mapstructure:",squash"`
	Bridge   *meshbridge.Options `yaml:"bridge,omitempty" json:"bridge,omitempty" toml:"bridge,omitempty" mapstructure:"bridge,omitempty"`
	Services *services.Options   `yaml:"services,omitempty" json:"services,omitempty" toml:"services,omitempty" mapstructure:"services,omitempty"`
}

Options are the node options.

func NewOptions

func NewOptions() *Options

NewOptions creates new options.

func (*Options) BindFlags

func (o *Options) BindFlags(fs *flag.FlagSet) *Options

BindFlags binds the flags. The options are returned for convenience.

func (*Options) DeepCopy

func (o *Options) DeepCopy() *Options

DeepCopy returns a deep copy of the options.

func (*Options) Marshal

func (o *Options) Marshal() ([]byte, error)

Marshal returns the marshaled options.

func (*Options) MarshalTo

func (o *Options) MarshalTo(w io.Writer) error

func (*Options) Validate

func (o *Options) Validate() error

Validate runs all the validation checks.