stdio

Documentation

Index

• type Streams
  • func New(stdin io.Reader, stdout, stderr io.Writer) Streams
• type TerminalInput
• type TerminalStreams
  • func NewTerminal(stdin TerminalInput, stdout, stderr io.Writer) TerminalStreams

Types

type Streams

type Streams struct {
	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer
}

Streams carries process stdio explicitly across package boundaries. Command entrypoints populate it and pass it into package code that needs terminal input or user-visible output.

func New

func New(stdin io.Reader, stdout, stderr io.Writer) Streams

New constructs a generic Streams bundle.

type TerminalInput

type TerminalInput interface {
	io.Reader
	Fd() uintptr
}

TerminalInput is a reader backed by a terminal file descriptor. Password prompts and other terminal interactions need both behaviors.

type TerminalStreams

type TerminalStreams struct {
	Streams
	Terminal TerminalInput
}

TerminalStreams extends Streams with a terminal-backed stdin for operations that need a file descriptor, such as password prompts.

func NewTerminal

func NewTerminal(stdin TerminalInput, stdout, stderr io.Writer) TerminalStreams

NewTerminal constructs a terminal-capable stream bundle.