iostreams

package
v0.1.77 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 11, 2023 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateLink(text string, url string) string

func EnvColorDisabled

func EnvColorDisabled() bool

func EnvColorForced

func EnvColorForced() bool

func Is256ColorSupported

func Is256ColorSupported() bool

func IsTerminalWriter added in v0.1.51

func IsTerminalWriter(w io.Writer) bool

func NewContext

func NewContext(ctx context.Context, io *IOStreams) context.Context

NewContext derives a context that carries io from ctx.

Types

type ColorScheme

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

func NewColorScheme

func NewColorScheme(enabled, is256enabled bool) *ColorScheme

func (*ColorScheme) Blue

func (c *ColorScheme) Blue(t string) string

func (*ColorScheme) Bold

func (c *ColorScheme) Bold(t string) string

func (*ColorScheme) ColorFromString

func (c *ColorScheme) ColorFromString(s string) func(string) string

func (*ColorScheme) Cyan

func (c *ColorScheme) Cyan(t string) string

func (*ColorScheme) CyanBold

func (c *ColorScheme) CyanBold(t string) string

func (*ColorScheme) FailureIcon

func (c *ColorScheme) FailureIcon() string

func (*ColorScheme) Gray

func (c *ColorScheme) Gray(t string) string

func (*ColorScheme) Green

func (c *ColorScheme) Green(t string) string

func (*ColorScheme) Italic added in v0.0.412

func (c *ColorScheme) Italic(t string) string

func (*ColorScheme) Magenta

func (c *ColorScheme) Magenta(t string) string

func (*ColorScheme) Red

func (c *ColorScheme) Red(t string) string

func (*ColorScheme) SuccessIcon

func (c *ColorScheme) SuccessIcon() string

func (*ColorScheme) SuccessIconWithColor

func (c *ColorScheme) SuccessIconWithColor(colo func(string) string) string

func (*ColorScheme) Underline added in v0.0.436

func (c *ColorScheme) Underline(t string) string

func (*ColorScheme) WarningIcon

func (c *ColorScheme) WarningIcon() string

func (*ColorScheme) Yellow

func (c *ColorScheme) Yellow(t string) string

type IOStreams

type IOStreams struct {
	In     io.ReadCloser
	Out    io.Writer
	ErrOut io.Writer

	TempFileOverride *os.File
	// contains filtered or unexported fields
}

func FromContext

func FromContext(ctx context.Context) *IOStreams

FromContext returns the IOStreams ctx carries. It panics in case ctx carries no IOStreams.

func System

func System() *IOStreams

func Test

func Test() (*IOStreams, *bytes.Buffer, *bytes.Buffer, *bytes.Buffer)

func (*IOStreams) CanPrompt

func (s *IOStreams) CanPrompt() bool

func (*IOStreams) ChangeProgressIndicatorMsg

func (s *IOStreams) ChangeProgressIndicatorMsg(msg string)

func (*IOStreams) ColorEnabled

func (s *IOStreams) ColorEnabled() bool

func (*IOStreams) ColorScheme

func (s *IOStreams) ColorScheme() *ColorScheme

func (*IOStreams) ColorSupport256

func (s *IOStreams) ColorSupport256() bool
func (s *IOStreams) CreateLink(text string, url string) string

func (*IOStreams) DetectTerminalTheme

func (s *IOStreams) DetectTerminalTheme() string

func (*IOStreams) IsInteractive

func (s *IOStreams) IsInteractive() bool

func (*IOStreams) IsStderrTTY

func (s *IOStreams) IsStderrTTY() bool

func (*IOStreams) IsStdinTTY

func (s *IOStreams) IsStdinTTY() bool

func (*IOStreams) IsStdoutTTY

func (s *IOStreams) IsStdoutTTY() bool

func (*IOStreams) ReadUserFile

func (s *IOStreams) ReadUserFile(fn string) ([]byte, error)

func (*IOStreams) SetNeverPrompt

func (s *IOStreams) SetNeverPrompt(v bool)

func (*IOStreams) SetPager

func (s *IOStreams) SetPager(cmd string)

func (*IOStreams) SetStderrTTY

func (s *IOStreams) SetStderrTTY(isTTY bool)

func (*IOStreams) SetStdinTTY

func (s *IOStreams) SetStdinTTY(isTTY bool)

func (*IOStreams) SetStdoutTTY

func (s *IOStreams) SetStdoutTTY(isTTY bool)

func (*IOStreams) StartPager

func (s *IOStreams) StartPager() error

func (*IOStreams) StartProgressIndicator

func (s *IOStreams) StartProgressIndicator()

func (*IOStreams) StartProgressIndicatorMsg

func (s *IOStreams) StartProgressIndicatorMsg(msg string)

func (*IOStreams) StderrFd

func (s *IOStreams) StderrFd() uintptr

func (*IOStreams) StdoutFd

func (s *IOStreams) StdoutFd() uintptr

func (*IOStreams) StopPager

func (s *IOStreams) StopPager()

func (*IOStreams) StopProgressIndicator

func (s *IOStreams) StopProgressIndicator()

func (*IOStreams) StopProgressIndicatorMsg

func (s *IOStreams) StopProgressIndicatorMsg(msg string)

func (*IOStreams) TempFile

func (s *IOStreams) TempFile(dir, pattern string) (*os.File, error)

func (*IOStreams) TerminalTheme

func (s *IOStreams) TerminalTheme() string

func (*IOStreams) TerminalWidth

func (s *IOStreams) TerminalWidth() int

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL