xpty

Documentation

Index

• Variables
• type Cmd
• type MockComputer
  • func (c *MockComputer) Read(p []byte) (int, error)
  • func (c *MockComputer) Write(p []byte) (int, error)
• type MockSession
  • func (s *MockSession) Close() error
  • func (s *MockSession) GetSize() (Size, error)
  • func (s *MockSession) SetSize(size Size) error
  • func (s *MockSession) StartProcess(cmd Cmd) (*os.Process, error)
• type MockTerminal
  • func (t *MockTerminal) Close() error
  • func (t *MockTerminal) Computer() *MockComputer
  • func (t *MockTerminal) Open() (Terminal, error)
  • func (t *MockTerminal) Read(p []byte) (int, error)
  • func (t *MockTerminal) Session(size Size) (Session, error)
  • func (t *MockTerminal) Write(p []byte) (int, error)
• type Session
• type Size
• type SizeError
  • func (e *SizeError) Error() string
• type Terminal
  • func Open() (Terminal, error)

Variables

var (
	ErrMockTerminalOpen    = errors.New("xpty: mock terminal open")
	ErrMockTerminalNotOpen = errors.New("xpty: mock terminal not open")
	ErrMockSessionOpen     = errors.New("xpty: mock session open")
	ErrMockSessionNotOpen  = errors.New("xpty: mock session not open")
)

var ErrUnsupported = errors.New("platform not supported by xpty")

Types

type Cmd

type Cmd struct {
	Path string
	Args []string
}

type MockComputer

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

func (*MockComputer) Read

func (c *MockComputer) Read(p []byte) (int, error)

func (*MockComputer) Write

func (c *MockComputer) Write(p []byte) (int, error)

type MockSession

type MockSession struct {
	T *MockTerminal
}

func (*MockSession) Close

func (s *MockSession) Close() error

func (*MockSession) GetSize

func (s *MockSession) GetSize() (Size, error)

func (*MockSession) SetSize

func (s *MockSession) SetSize(size Size) error

func (*MockSession) StartProcess

func (s *MockSession) StartProcess(cmd Cmd) (*os.Process, error)

type MockTerminal

type MockTerminal struct {
	ErrOpen          error
	ErrSession       error
	ErrStartProcess  error
	ErrGetSize       error
	ErrSetSize       error
	ErrCloseSession  error
	ErrCloseTerminal error
	PID              int

	Size         Size
	Cmd          Cmd
	OpenTerminal bool
	OpenSession  bool
	// contains filtered or unexported fields
}

func (*MockTerminal) Close

func (t *MockTerminal) Close() error

func (*MockTerminal) Computer

func (t *MockTerminal) Computer() *MockComputer

func (*MockTerminal) Open

func (t *MockTerminal) Open() (Terminal, error)

func (*MockTerminal) Read

func (t *MockTerminal) Read(p []byte) (int, error)

func (*MockTerminal) Session

func (t *MockTerminal) Session(size Size) (Session, error)

func (*MockTerminal) Write

func (t *MockTerminal) Write(p []byte) (int, error)

type Session

type Session interface {
	StartProcess(cmd Cmd) (*os.Process, error)
	GetSize() (Size, error)
	SetSize(Size) error
	Close() error
}

type Size

type Size struct {
	Row, Col int
}

type SizeError

type SizeError struct {
	Size Size
}

func (*SizeError) Error

func (e *SizeError) Error() string

type Terminal

type Terminal interface {
	io.ReadWriteCloser
	Session(Size) (Session, error)
}

func Open

func Open() (Terminal, error)