tmuxopt

Documentation

Overview

Package tmuxopt provides an API for loading and parsing tmux options into Go variables.

It provides an API similar to the flag package, but for tmux options.

Index

• type Loader
  • func (l *Loader) Load(req tmux.ShowOptionsRequest) (err error)
  • func (l *Loader) MapVar(val MapValue, prefix string)
  • func (l *Loader) StringVar(dest *string, option string)
  • func (l *Loader) Var(val Value, option string)
• type MapValue
• type Value

Types

type Loader

type Loader struct {
	Tmux tmux.Driver
	// contains filtered or unexported fields
}

Loader loads tmux options into user-specified variables.

func (*Loader) Load

func (l *Loader) Load(req tmux.ShowOptionsRequest) (err error)

Load loads tmux options using the underlying tmux.Driver with the provided request. This will fill all previously specified values and vars.

func (*Loader) MapVar

func (l *Loader) MapVar(val MapValue, prefix string)

MapVar specifies that options with the given prefix should be loaded into the provided MapValue.

To support maps, tmuxopt loader works by matching the provided prefix against options produced by tmux. If an option name matches the given prefix, the rest of that name is used as the map key and the value for that option as the value for that key.

For example, if the prefix is, "foo-item-", then given the following options,

foo-item-a x
foo-item-b y
foo-item-c z

We'll get the map,

{a: x, b: y, c: z}

func (*Loader) StringVar

func (l *Loader) StringVar(dest *string, option string)

StringVar specifies that the given option should be loaded as a string.

func (*Loader) Var

func (l *Loader) Var(val Value, option string)

Var specifies that the given option should be loaded into the provided Value object.

type MapValue

type MapValue interface {
	Put(key, value string) error
}

MapValue is a receiver for a tmux map value.

type Value

type Value interface {
	Set(value string) error
}

Value is a receiver for a tmux option value.