stub

Documentation

Overview

Package stub is used to start and manage an elvish-stub process.

Index

• Variables
• type BadSignal
  • func (BadSignal) Signal()
  • func (bs BadSignal) String() string
• type Stub
  • func NewStub(stderr *os.File) (*Stub, error)
  • func (stub *Stub) Alive() bool
  • func (stub *Stub) Chdir(dir string)
  • func (stub *Stub) Process() *os.Process
  • func (stub *Stub) SetTitle(s string)
  • func (stub *Stub) Signals() <-chan os.Signal
  • func (stub *Stub) State() <-chan struct{}
  • func (stub *Stub) Terminate()

Variables

var Logger = util.GetLogger("[stub] ")

Types

type BadSignal

type BadSignal struct {
	Error error
}

func (BadSignal) Signal

func (BadSignal) Signal()

func (BadSignal) String

func (bs BadSignal) String() string

type Stub

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

func NewStub

func NewStub(stderr *os.File) (*Stub, error)

NewStub spawns a new stub. The specified stderr is used for the subprocess.

func (*Stub) Alive

func (stub *Stub) Alive() bool

Alive reports whether the stub is alive.

func (*Stub) Chdir

func (stub *Stub) Chdir(dir string)

func (*Stub) Process

func (stub *Stub) Process() *os.Process

func (*Stub) SetTitle

func (stub *Stub) SetTitle(s string)

SetTitle sets the title of the stub.

func (*Stub) Signals

func (stub *Stub) Signals() <-chan os.Signal

Signals returns a channel into which signals sent to the stub are relayed.

func (*Stub) State

func (stub *Stub) State() <-chan struct{}

State returns a channel that is closed when the stub exits.

func (*Stub) Terminate

func (stub *Stub) Terminate()

Terminate terminates the stub.