term

Documentation

Index

• type Session
  • func NewSession() *Session
  • func (s *Session) End()
  • func (s *Session) GetCliWidth() int
  • func (s *Session) MakeRaw() error
  • func (s *Session) Start()

Types

type Session

type Session struct {
	PreviousState *terminal.State
	StdinFd       int
	Paused        bool
	Reset         bool
}

Session tracks the current terminal session.

func NewSession

func NewSession() *Session

NewSession creates a new session

func (*Session) End

func (s *Session) End()

End returns the terminal to its state from before hlstail started.

func (*Session) GetCliWidth

func (s *Session) GetCliWidth() int

GetCliWidth returns the available screen space

func (*Session) MakeRaw

func (s *Session) MakeRaw() error

MakeRaw sets the terminal in raw mode.

func (*Session) Start

func (s *Session) Start()

Start will setup the stdout for printing.