iostreams

package
v0.8.7-273-gc573eb4e Latest Latest
Warning

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

 Go to latest Published: Jul 17, 2024 License: BSD-3-Clause Imports: 19 Imported by: 3

Documentation

Overview

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: MIT

Copyright (c) 2019 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

Constants

View Source 
const DefaultWidth = 80

Variables

View Source 
var (
	Magenta  = ansi.ColorFunc("magenta")
	Cyan     = ansi.ColorFunc("cyan")
	Red      = ansi.ColorFunc("red")
	Yellow   = ansi.ColorFunc("yellow")
	Blue     = ansi.ColorFunc("blue")
	Green    = ansi.ColorFunc("green")
	Gray     = ansi.ColorFunc("black+h")
	Bold     = ansi.ColorFunc("default+b")
	CyanBold = ansi.ColorFunc("cyan+b")

	Gray256 = func(t string) string {
		return fmt.Sprintf("\x1b[%d;5;%dm%s\x1b[m", 38, 242, t)
	}
)
View Source 
var (
	// G is an alias for FromContext.
	//
	// We may want to define this locally to a package to get package tagged
	// iostreams.
	G = FromContext

	// L is the system IO stream.
	IO = System()
)

Functions

func EnvColorDisabled 

func EnvColorDisabled() bool

func EnvColorForced 

func EnvColorForced() bool

func Is256ColorSupported 

func Is256ColorSupported() bool

func IsTrueColorSupported 

func IsTrueColorSupported() bool

func NewNoTTYReader added in v0.4.2 

func NewNoTTYReader(r io.ReadCloser, ptr uintptr) *fdReader

func NewNoTTYWriter added in v0.4.2 

func NewNoTTYWriter(w io.Writer, ptr uintptr) *fdWriter

func WithIOStreams added in v0.2.0 

func WithIOStreams(ctx context.Context, iostreams *IOStreams) context.Context

WithIOStreams returns a new context with the provided logger. Use in combination with logger.WithField(s) for great effect.

Types

type ColorScheme 

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

func NewColorScheme 

func NewColorScheme(enabled, is256enabled bool, trueColor bool) *ColorScheme

func (*ColorScheme) Blue 

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

func (*ColorScheme) Bluef 

func (c *ColorScheme) Bluef(t string, args ...interface{}) string

func (*ColorScheme) Bold 

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

func (*ColorScheme) Boldf 

func (c *ColorScheme) Boldf(t string, args ...interface{}) 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) Cyanf 

func (c *ColorScheme) Cyanf(t string, args ...interface{}) string

func (*ColorScheme) FailureIcon 

func (c *ColorScheme) FailureIcon() string

func (*ColorScheme) FailureIconWithColor 

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

func (*ColorScheme) Gray 

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

func (*ColorScheme) Grayf 

func (c *ColorScheme) Grayf(t string, args ...interface{}) string

func (*ColorScheme) Green 

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

func (*ColorScheme) Greenf 

func (c *ColorScheme) Greenf(t string, args ...interface{}) string

func (*ColorScheme) HexToRGB 

func (c *ColorScheme) HexToRGB(hex string, x string) string

func (*ColorScheme) Magenta 

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

func (*ColorScheme) Magentaf 

func (c *ColorScheme) Magentaf(t string, args ...interface{}) string

func (*ColorScheme) Red 

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

func (*ColorScheme) Redf 

func (c *ColorScheme) Redf(t string, args ...interface{}) string

func (*ColorScheme) SprintFunc 

func (c *ColorScheme) SprintFunc(s string) func(a ...interface{}) string

SprintFunc returns a new function that returns colorized strings for the given arguments with fmt.Sprint(). Useful to put into or mix into other string. Windows users should use this in conjunction with color.Output, example: 

put := New(FgYellow).SprintFunc()
fmt.Fprintf(color.Output, "This is a %s", put("warning"))

func (*ColorScheme) SuccessIcon 

func (c *ColorScheme) SuccessIcon() string

func (*ColorScheme) SuccessIconWithColor 

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

func (*ColorScheme) WarningIcon 

func (c *ColorScheme) WarningIcon() string

func (*ColorScheme) Yellow 

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

func (*ColorScheme) Yellowf 

func (c *ColorScheme) Yellowf(t string, args ...interface{}) string

type ErrClosedPagerPipe 

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

ErrClosedPagerPipe is the error returned when writing to a pager that has been closed.

type FileWriter added in v0.7.0 

type FileWriter interface {
	io.Writer
	Fd() uintptr
}

type IOStreams 

type IOStreams struct {
	In     fileReader
	Out    FileWriter
	ErrOut io.Writer

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

func FromContext added in v0.2.0 

func FromContext(ctx context.Context) *IOStreams

FromContext returns the logger kraftkit in the context, or an inert logger that will not log anything.

func System 

func System() *IOStreams

func (*IOStreams) CanPrompt 

func (s *IOStreams) CanPrompt() bool

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 (*IOStreams) DetectTerminalTheme 

func (s *IOStreams) DetectTerminalTheme()

DetectTerminalTheme is a utility to call before starting the output pager so that the terminal background can be reliably detected.

func (*IOStreams) GetNeverPrompt 

func (s *IOStreams) GetNeverPrompt() bool

func (*IOStreams) GetPager 

func (s *IOStreams) GetPager() string

func (*IOStreams) HasTrueColor 

func (s *IOStreams) HasTrueColor() 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) RefreshScreen added in v0.4.2 

func (s *IOStreams) RefreshScreen()

func (*IOStreams) SetAlternateScreenBufferEnabled added in v0.4.2 

func (s *IOStreams) SetAlternateScreenBufferEnabled(enabled bool)

func (*IOStreams) SetColorEnabled 

func (s *IOStreams) SetColorEnabled(colorEnabled bool)

func (*IOStreams) SetIn added in v0.4.2 

func (s *IOStreams) SetIn(in fileReader)

func (*IOStreams) SetNeverPrompt 

func (s *IOStreams) SetNeverPrompt(v bool)

func (*IOStreams) SetOut added in v0.4.2 

func (s *IOStreams) SetOut(out FileWriter)

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) StartAlternateScreenBuffer added in v0.4.2 

func (s *IOStreams) StartAlternateScreenBuffer()

func (*IOStreams) StartPager 

func (s *IOStreams) StartPager() error

func (*IOStreams) StartProgressIndicator 

func (s *IOStreams) StartProgressIndicator()

func (*IOStreams) StartProgressIndicatorWithLabel 

func (s *IOStreams) StartProgressIndicatorWithLabel(label string)

func (*IOStreams) StopAlternateScreenBuffer added in v0.4.2 

func (s *IOStreams) StopAlternateScreenBuffer()

func (*IOStreams) StopPager 

func (s *IOStreams) StopPager()

func (*IOStreams) StopProgressIndicator 

func (s *IOStreams) StopProgressIndicator()

func (*IOStreams) TempFile 

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

func (*IOStreams) TerminalTheme 

func (s *IOStreams) TerminalTheme() string

TerminalTheme returns "light", "dark", or "none" depending on the background color of the terminal.

func (*IOStreams) TerminalWidth 

func (s *IOStreams) TerminalWidth() int

TerminalWidth returns the width of the terminal that controls the process

type Terminal added in v0.4.2 

type Terminal interface {
	IsTerminalOutput() bool
	IsColorEnabled() bool
	Is256ColorSupported() bool
	IsTrueColorSupported() bool
	Theme() string
	Size() (int, int, error)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.