defaults

Documentation

Index

• Variables
• type Client
  • func NewClient(addr, port string) *Client
  • func (c *Client) Aside() ([]byte, error)
  • func (c *Client) Attach() error
  • func (c *Client) Auth() error
  • func (c *Client) Cleanup()
  • func (c *Client) Command(cmd *commander.Command) (int, error)
  • func (c *Client) Connect(debug bool) (err error)
  • func (c *Client) Ctl() ([]byte, error)
  • func (c *Client) Document() ([]byte, error)
  • func (c *Client) Feed() (io.ReadCloser, error)
  • func (c *Client) GetCommands() ([]*commander.Command, error)
  • func (c *Client) Input(data []byte) (int, error)
  • func (c *Client) Notifications() ([]byte, error)
  • func (c *Client) Send(cmd *commander.Command, data []string) (int, error)
  • func (c *Client) Status() ([]byte, error)
  • func (c *Client) Tabs() ([]byte, error)
  • func (c *Client) Title() ([]byte, error)

Variables

var Commands = []*commander.Command{
	{
		Name:        "title",
		Args:        []string{},
		Heading:     commander.DefaultGroup,
		Description: "print the title of the current buffer",
	},
	{
		Name:        "aside",
		Args:        []string{},
		Heading:     commander.DefaultGroup,
		Description: "print the aside data of the current buffer",
	},
	{
		Name:        "status",
		Args:        []string{},
		Heading:     commander.DefaultGroup,
		Description: "print the status of the current buffer",
	},
	{
		Name:        "tabs",
		Args:        []string{},
		Heading:     commander.DefaultGroup,
		Description: "print a list of all connected buffers",
	},
	{
		Name:        "notify",
		Args:        []string{},
		Heading:     commander.DefaultGroup,
		Description: "print and clear any pending notifications",
	},
}

Types

type Client

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

func NewClient

func NewClient(addr, port string) *Client

func (*Client) Aside

func (c *Client) Aside() ([]byte, error)

func (*Client) Attach

func (c *Client) Attach() error

func (*Client) Auth

func (c *Client) Auth() error

func (*Client) Cleanup

func (c *Client) Cleanup()

func (*Client) Command

func (c *Client) Command(cmd *commander.Command) (int, error)

Command will write a command, returning an error if the command is not supported by the service It will set cmd.From on your behalf

func (*Client) Connect

func (c *Client) Connect(debug bool) (err error)

func (*Client) Ctl

func (c *Client) Ctl() ([]byte, error)

func (*Client) Document

func (c *Client) Document() ([]byte, error)

func (*Client) Feed

func (c *Client) Feed() (io.ReadCloser, error)

func (*Client) GetCommands

func (c *Client) GetCommands() ([]*commander.Command, error)

GetCommands initializes the internal cmdlist

func (*Client) Input

func (c *Client) Input(data []byte) (int, error)

func (*Client) Notifications

func (c *Client) Notifications() ([]byte, error)

func (*Client) Send

func (c *Client) Send(cmd *commander.Command, data []string) (int, error)

func (*Client) Status

func (c *Client) Status() ([]byte, error)

func (*Client) Tabs

func (c *Client) Tabs() ([]byte, error)

func (*Client) Title

func (c *Client) Title() ([]byte, error)