pty

package

v0.1.20 Latest Latest Go to latest Published: Jul 3, 2018 License: MPL-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

View Source

const Supported = true

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

This section is empty.

This section is empty.

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

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

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 *PTY) Close() error

Close will close the PTY

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

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

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

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