conpty

Documentation

Index

• Variables
• func IsConPtyAvailable() bool
• type ConPty
  • func Start(commandLine string, options ...ConPtyOption) (*ConPty, error)
  • func (cpty *ConPty) Close() error
  • func (cpty *ConPty) Pid() int
  • func (cpty *ConPty) Read(p []byte) (int, error)
  • func (cpty *ConPty) Resize(width, height int16) error
  • func (cpty *ConPty) Wait(ctx context.Context) (uint32, error)
  • func (cpty *ConPty) Write(p []byte) (int, error)
• type ConPtyOption
  • func ConPtyDimensions(width, height int) ConPtyOption
  • func ConPtyEnv(env []string) ConPtyOption
  • func ConPtyWorkDir(workDir string) ConPtyOption

Variables

var (
	ErrConPtyUnsupported = errors.New("ConPty is not available on this version of Windows")
)

Functions

func IsConPtyAvailable

func IsConPtyAvailable() bool

Types

type ConPty

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

func Start

func Start(commandLine string, options ...ConPtyOption) (*ConPty, error)

Start a new process specified in `commandLine` and attach a pseudo console using the Windows ConPty API. If ConPty is not available, ErrConPtyUnsupported will be returned.

On successful return, an instance of ConPty is returned. You must call Close() on this to release any resources associated with the process. To get the exit code of the process, you can call Wait().

func (*ConPty) Close

func (cpty *ConPty) Close() error

Close all open handles and terminate the process.

func (*ConPty) Pid

func (cpty *ConPty) Pid() int

func (*ConPty) Read

func (cpty *ConPty) Read(p []byte) (int, error)

func (*ConPty) Resize

func (cpty *ConPty) Resize(width, height int16) error

func (*ConPty) Wait

func (cpty *ConPty) Wait(ctx context.Context) (uint32, error)

Wait for the process to exit and return the exit code. If context is canceled, Wait() will return STILL_ACTIVE and an error indicating the context was canceled.

func (*ConPty) Write

func (cpty *ConPty) Write(p []byte) (int, error)

type ConPtyOption

type ConPtyOption func(args *conPtyArgs)

func ConPtyDimensions

func ConPtyDimensions(width, height int) ConPtyOption

func ConPtyEnv

func ConPtyEnv(env []string) ConPtyOption

func ConPtyWorkDir

func ConPtyWorkDir(workDir string) ConPtyOption