color

Documentation

Overview

Package color enable color output for terminal use ansi escape code

Index

• Constants
• Variables
• func Has(c string) bool
• type Renderer
  • func Fg(color string) *Renderer
  • func FgHl(color string) *Renderer
  • func New(codes ...string) *Renderer
  • func (r *Renderer) Begin(w io.Writer) error
  • func (r *Renderer) Disable()
  • func (r *Renderer) End(w io.Writer) error
  • func (r *Renderer) Error(args ...interface{}) (int, error)
  • func (r *Renderer) Errorf(format string, args ...interface{}) (int, error)
  • func (r *Renderer) Errorln(args ...interface{}) (int, error)
  • func (r *Renderer) Fprint(w io.Writer, args ...interface{}) (int, error)
  • func (r *Renderer) Fprintf(w io.Writer, format string, args ...interface{}) (int, error)
  • func (r *Renderer) Fprintln(w io.Writer, args ...interface{}) (int, error)
  • func (r *Renderer) Print(args ...interface{}) (int, error)
  • func (r *Renderer) Printf(format string, args ...interface{}) (int, error)
  • func (r *Renderer) Println(args ...interface{}) (int, error)
  • func (r *Renderer) Render(str string) string
  • func (r *Renderer) RenderTo(w io.Writer, str string) (int, error)
  • func (r *Renderer) Sprint(args ...interface{}) string
  • func (r *Renderer) Sprintf(format string, args ...interface{}) string
  • func (r *Renderer) Sprintln(args ...interface{}) string
  • func (r *Renderer) Writer(prefix string, w io.Writer) io.Writer
• type Writer
  • func (w Writer) Write(bs []byte) (int, error)

Constants

const (
	BLACK   = "black"
	RED     = "red"
	GREEN   = "green"
	YELLOW  = "yellow"
	BLUE    = "blue"
	MAGENTA = "magenta"
	CYAN    = "cyan"
	WHITE   = "white"
)

Variables

var (
	LightBlack   = FgHl(BLACK)
	LightRed     = FgHl(RED)
	LightGreen   = FgHl(GREEN)
	LightYellow  = FgHl(YELLOW)
	LightBlue    = FgHl((BLUE))
	LightMagenta = FgHl(MAGENTA)
	LightCyan    = FgHl(CYAN)
	LightWhite   = FgHl(WHITE)

	Black   = Fg(BLACK)
	Red     = Fg(RED)
	Green   = Fg(GREEN)
	Yellow  = Fg(YELLOW)
	Blue    = Fg((BLUE))
	Magenta = Fg(MAGENTA)
	Cyan    = Fg(CYAN)
	White   = Fg(WHITE)
)

Functions

func Has

func Has(c string) bool

Has check whether a color can be use

Types

type Renderer

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

Renderer is a render for terminal string

func Fg

func Fg(color string) *Renderer

Fg is a quick way to New().Fg(color).Finish()

func FgHl

func FgHl(color string) *Renderer

FgHl is a quick way to New().Fg(color).Highlight().Finish()

func New

func New(codes ...string) *Renderer

New a terminal color render,

func (*Renderer) Begin

func (r *Renderer) Begin(w io.Writer) error

func (*Renderer) Disable

func (r *Renderer) Disable()

Disable color render

func (*Renderer) End

func (r *Renderer) End(w io.Writer) error

func (*Renderer) Error

func (r *Renderer) Error(args ...interface{}) (int, error)

func (*Renderer) Errorf

func (r *Renderer) Errorf(format string, args ...interface{}) (int, error)

func (*Renderer) Errorln

func (r *Renderer) Errorln(args ...interface{}) (int, error)

func (*Renderer) Fprint

func (r *Renderer) Fprint(w io.Writer, args ...interface{}) (int, error)

func (*Renderer) Fprintf

func (r *Renderer) Fprintf(w io.Writer, format string, args ...interface{}) (int, error)

func (*Renderer) Fprintln

func (r *Renderer) Fprintln(w io.Writer, args ...interface{}) (int, error)

func (*Renderer) Print

func (r *Renderer) Print(args ...interface{}) (int, error)

func (*Renderer) Printf

func (r *Renderer) Printf(format string, args ...interface{}) (int, error)

func (*Renderer) Println

func (r *Renderer) Println(args ...interface{}) (int, error)

func (*Renderer) Render

func (r *Renderer) Render(str string) string

Render rend a string

func (*Renderer) RenderTo

func (r *Renderer) RenderTo(w io.Writer, str string) (int, error)

RenderTo render string to writer

func (*Renderer) Sprint

func (r *Renderer) Sprint(args ...interface{}) string

func (*Renderer) Sprintf

func (r *Renderer) Sprintf(format string, args ...interface{}) string

func (*Renderer) Sprintln

func (r *Renderer) Sprintln(args ...interface{}) string

func (*Renderer) Writer

func (r *Renderer) Writer(prefix string, w io.Writer) io.Writer

type Writer

type Writer struct {
	Prefix string
	io.Writer
	*Renderer
}

func (Writer) Write

func (w Writer) Write(bs []byte) (int, error)