aliasconf

Documentation

Index

• type AliasJSON
  • func (doc *AliasJSON) Flush() error
  • func (doc *AliasJSON) GetAlias(key string) (AliasValue, error)
  • func (doc *AliasJSON) GetAliases() []string
  • func (doc *AliasJSON) Load() error
  • func (doc *AliasJSON) SetAlias(key string, alias AliasValue)
• type AliasMap
• type AliasValue
• type Aliaser

Types

type AliasJSON

type AliasJSON struct {
	// contains filtered or unexported fields
}

func (*AliasJSON) Flush

func (doc *AliasJSON) Flush() error

func (*AliasJSON) GetAlias

func (doc *AliasJSON) GetAlias(key string) (AliasValue, error)

func (*AliasJSON) GetAliases

func (doc *AliasJSON) GetAliases() []string

func (*AliasJSON) Load

func (doc *AliasJSON) Load() error

func (*AliasJSON) SetAlias

func (doc *AliasJSON) SetAlias(key string, alias AliasValue)

type AliasMap

type AliasMap map[string]AliasValue

type AliasValue

type AliasValue struct {
	// Path the alias points to
	Path string
	// Description of the alias
	Desc string
}

AliasValue is the content of an alias

type Aliaser

type Aliaser interface {
	GetAlias(key string) (AliasValue, error)
	SetAlias(key string, value AliasValue)
	GetAliases() []string
	// Flush saves actual aliases to file
	Flush() error
	// Load all aliases from file
	Load() error
}

Aliaser defines interface for getting, setting and persisting aliases