Documentation ¶
Overview ¶
Package colour ([docs]1) provides [Quake-style colour formatting]2 for Unix terminals.
It is a drop-in replacement for the fmt package.
The package level functions can be used to write to stdout (or strings or other files). If stdout is not a terminal, colour formatting will be stripped.
eg.
colour.Printf("^0black ^1red ^2green ^3yellow ^4blue ^5magenta ^6cyan ^7white^R\n")
For more control a Printer object can be created with various helper functions. This can be used to do useful things such as strip formatting, write to strings, and so on.
The following sequences are converted to their equivalent ANSI colours:
^0 = Black ^1 = Red ^2 = Green ^3 = Yellow ^4 = Blue ^5 = Cyan (light blue) ^6 = Magenta (purple) ^7 = White ^8 = Black Background ^9 = Red Background ^a = Green Background ^b = Yellow Background ^c = Blue Background ^d = Cyan (light blue) Background ^e = Magenta (purple) Background ^f = White Background ^R = Reset ^U = Underline ^B = Bold ^S = Strikethrough
Index ¶
- Variables
- func FormatString(s string) string
- func Fprint(w io.Writer, args ...interface{}) (n int, err error)
- func Fprintf(w io.Writer, format string, args ...interface{}) (n int, err error)
- func Fprintln(w io.Writer, args ...interface{}) (n int, err error)
- func Print(args ...interface{}) (n int, err error)
- func Printf(format string, args ...interface{}) (n int, err error)
- func Println(args ...interface{}) (n int, err error)
- func Sprint(args ...interface{}) string
- func Sprintf(format string, args ...interface{}) string
- func Sprintln(args ...interface{}) string
- func StripFormatting(s string) string
- type Printer
- type StringPrinter
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func FormatString ¶
func StripFormatting ¶
Types ¶
type Printer ¶
type Printer interface { Println(args ...interface{}) (n int, err error) Print(args ...interface{}) (n int, err error) Printf(format string, args ...interface{}) (n int, err error) }
A Printer implements functions that accept Quake-style colour formatting and print coloured text.
type StringPrinter ¶
type StringPrinter struct { Printer // contains filtered or unexported fields }
func String ¶
func String() *StringPrinter
String creates a new Printer that writes ANSI coloured text to a buffer. Use the String() method to return the printed string.
func StringStripper ¶
func StringStripper() *StringPrinter
StringStripper writes text stripped of colour formatting codes to a string. Use the String() method to return the printed string.
func (*StringPrinter) String ¶
func (s *StringPrinter) String() string