console

README

Console

Console is a small wrapper around https://github.com/moby/term exposing a similar interface than the one provided by https://github.com/containerd/console.

Documentation

Index

• Variables
• type Console
  • func Current() (c Console)
  • func FromFile(f *os.File) (Console, error)
• type File
• type WinSize

Variables

var (
	ErrNotAConsole = errors.New("provided file is not a console")
	ErrUnsupported = errors.New("unsupported operation")
)

Types

type Console

type Console interface {
	File

	// Resize resizes the console to the provided window size
	Resize(WinSize) error
	// SetRaw sets the console in raw mode
	SetRaw() error
	// DisableEcho disables echo on the console
	DisableEcho() error
	// Reset restores the console to its orignal state
	Reset() error
	// Size returns the window size of the console
	Size() (WinSize, error)
}

func Current

func Current() (c Console)

Current returns the current process' console

func FromFile

func FromFile(f *os.File) (Console, error)

FromFile returns a Console from the provided file

type File

type File interface {
	io.ReadWriteCloser

	// Fd returns its file descriptor
	Fd() uintptr
	// Name returns its file name
	Name() string
}

type WinSize

type WinSize struct {
	// Height of the console
	Height uint16
	// Width of the console
	Width uint16
	// contains filtered or unexported fields
}

WinSize specifies the window size of the console