pty

Documentation

Index

• Constants
• type PTY
  • func Start(cmd *exec.Cmd) (*PTY, error)
  • func (pty *PTY) Close() error
  • func (pty *PTY) Read(p []byte) (n int, err error)
  • func (pty *PTY) SetSize(cols, rows uint16) error
  • func (pty *PTY) Write(p []byte) (n int, err error)

Constants

const Supported = true

Supported is true, if PTY is supported on the given platform

Types

type PTY

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

PTY holds the pseduo-tty that an exec.Cmd is running in.

func Start

func Start(cmd *exec.Cmd) (*PTY, error)

Start will create start cmd and return a PTY wrapping it. The PTY implements ReadWriteCloser and must be closed when execution is done.

Note: This will overwrite stdio for cmd.

func (*PTY) Close

func (pty *PTY) Close() error

Close will close the PTY

func (*PTY) Read

func (pty *PTY) Read(p []byte) (n int, err error)

func (*PTY) SetSize

func (pty *PTY) SetSize(cols, rows uint16) error

SetSize will set the TTY size, returns engines.ErrFeatureNotSupported on unsupported platforms.

func (*PTY) Write

func (pty *PTY) Write(p []byte) (n int, err error)