console

package module

v1.1.0 Latest Latest Go to latest Published: Apr 24, 2024 License: MIT Imports: 7 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Eclalang/console

Links

Open Source Insights

README ¶

Console library

Candidate functions :

Func name	Prototype	Description	Comments
Clear	Clear()	Clears the console	N/A
Input	Input() string {}	Takes user input from console and returns a string	N/A
InputFloat	InputFloat() (float, error) {}	Takes user input from console and returns a float64	N/A
InputInt	InputInt() (int, error) {}	Takes user input from console and returns an int	N/A
Print	Print(args ...any) {}	Prints args to console	N/A
Printf	Printf(format string, args ...any) {}	Prints args to console formatted with format	N/A
PrintInColor	PrintInColor(color string, args ...any) {}	Prints args to console in color	N/A
Println	Println(args ...any) {}	Prints args to console with a newline	N/A
SPrint	SPrint(args ...any) string {}	Returns a string with the args using the default formats	N/A
SPrintf	SPrintf(format string, args ...any) string {}	Returns a string with the args formatted with format	N/A
SPrintln	SPrintln(args ...any) string {}	Returns a string with the args and a newline at the end	N/A

Colors constants :

Regular colors

Color Name	Detail
COLOROFF	Reset color
BLACK	Black
BLUE	Blue
CYAN	Cyan
GREEN	Green
MAGENTA	Magenta
RED	Red
WHITE	White
YELLOW	Yellow

Bold colors

Color Name	Detail
B_BLACK	Black
B_BLUE	Blue
B_CYAN	Cyan
B_GREEN	Green
B_MAGENTA	Magenta
B_RED	Red
B_WHITE	White
B_YELLOW	Yellow

Underline colors

Color Name	Detail
U_BLACK	Black
U_BLUE	Blue
U_CYAN	Cyan
U_GREEN	Green
U_MAGENTA	Magenta
U_RED	Red
U_WHITE	White
U_YELLOW	Yellow

Background colors

Color Name	Detail
ON_BLACK	Black
ON_BLUE	Blue
ON_CYAN	Cyan
ON_GREEN	Green
ON_MAGENTA	Magenta
ON_RED	Red
ON_WHITE	White
ON_YELLOW	Yellow

High intensity colors

Color Name	Detail
I_BLACK	Black
I_BLUE	Blue
I_CYAN	Cyan
I_GREEN	Green
I_MAGENTA	Magenta
I_RED	Red
I_WHITE	White
I_YELLOW	Yellow

Bold high intensity colors

Color Name	Detail
BI_BLACK	Black
BI_BLUE	Blue
BI_CYAN	Cyan
BI_GREEN	Green
BI_MAGENTA	Magenta
BI_RED	Red
BI_WHITE	White
BI_YELLOW	Yellow

High intensity background colors

Color Name	Detail
ONI_BLACK	Black
ONI_BLUE	Blue
ONI_CYAN	Cyan
ONI_GREEN	Green
ONI_MAGENTA	Magenta
ONI_RED	Red
ONI_WHITE	White
ONI_YELLOW	Yellow

Documentation ¶

Index ¶

Variables
func Clear()
func Input() string
func InputFloat() (float64, error)
func InputInt() (int, error)
func Print(args ...any)
func PrintInColor(color string, args ...any)
func Printf(format string, args ...any)
func Println(args ...any)
func SPrint(args ...any) string
func SPrintf(format string, args ...any) string
func SPrintln(args ...any) string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Reset
	ColorOff = "\033[0m" // Text Reset

	// Regular
	BLACK   = "\033[0;30m" // Black
	RED     = "\033[0;31m" // Red
	GREEN   = "\033[0;32m" // Green
	YELLOW  = "\033[0;33m" // Yellow
	BLUE    = "\033[0;34m" // Blue
	MAGENTA = "\033[0;35m" // Magenta
	CYAN    = "\033[0;36m" // Cyan
	WHITE   = "\033[0;37m" // White

	// Bold
	BBlack   = "\033[1;30m" // Black
	BRed     = "\033[1;31m" // Red
	BGreen   = "\033[1;32m" // Green
	BYellow  = "\033[1;33m" // Yellow
	BBlue    = "\033[1;34m" // Blue
	BMagenta = "\033[1;35m" // Magenta
	BCyan    = "\033[1;36m" // Cyan
	BWhite   = "\033[1;37m" // White

	// Underline
	UBlack   = "\033[4;30m" // Black
	URed     = "\033[4;31m" // Red
	UGreen   = "\033[4;32m" // Green
	UYellow  = "\033[4;33m" // Yellow
	UBlue    = "\033[4;34m" // Blue
	UMagenta = "\033[4;35m" // Magenta
	UCyan    = "\033[4;36m" // Cyan
	UWhite   = "\033[4;37m" // White

	// Background
	On_Black   = "\033[40m" // Black
	On_Red     = "\033[41m" // Red
	On_Green   = "\033[42m" // Green
	On_Yellow  = "\033[43m" // Yellow
	On_Blue    = "\033[44m" // Blue
	On_Magenta = "\033[45m" // Magenta
	On_Cyan    = "\033[46m" // Cyan
	On_White   = "\033[47m" // White

	// High Intensity
	IBlack   = "\033[0;90m" // Black
	IRed     = "\033[0;91m" // Red
	IGreen   = "\033[0;92m" // Green
	IYellow  = "\033[0;93m" // Yellow
	IBlue    = "\033[0;94m" // Blue
	IMagenta = "\033[0;95m" // Magenta
	ICyan    = "\033[0;96m" // Cyan
	IWhite   = "\033[0;97m" // White

	// Bold High Intensity
	BIBlack   = "\033[1;90m" // Black
	BIRed     = "\033[1;91m" // Red
	BIGreen   = "\033[1;92m" // Green
	BIYellow  = "\033[1;93m" // Yellow
	BIBlue    = "\033[1;94m" // Blue
	BIMagenta = "\033[1;95m" // Magenta
	BICyan    = "\033[1;96m" // Cyan
	BIWhite   = "\033[1;97m" // White

	// High Intensity backgrounds
	On_IBlack   = "\033[0;100m" // Black
	On_IRed     = "\033[0;101m" // Red
	On_IGreen   = "\033[0;102m" // Green
	On_IYellow  = "\033[0;103m" // Yellow
	On_IBlue    = "\033[0;104m" // Blue
	On_IMagenta = "\033[0;105m" // Magenta
	On_ICyan    = "\033[0;106m" // Cyan
	On_IWhite   = "\033[0;107m" // White

	// Map of variables for Ecla
	Variables = map[string]eclaType.Type{
		"COLOROFF": eclaType.String(ColorOff),

		"BLACK":   eclaType.String(BLACK),
		"RED":     eclaType.String(RED),
		"GREEN":   eclaType.String(GREEN),
		"YELLOW":  eclaType.String(YELLOW),
		"BLUE":    eclaType.String(BLUE),
		"MAGENTA": eclaType.String(MAGENTA),
		"CYAN":    eclaType.String(CYAN),
		"WHITE":   eclaType.String(WHITE),

		"B_BLACK":   eclaType.String(BBlack),
		"B_RED":     eclaType.String(BRed),
		"B_GREEN":   eclaType.String(BGreen),
		"B_YELLOW":  eclaType.String(BYellow),
		"B_BLUE":    eclaType.String(BBlue),
		"B_MAGENTA": eclaType.String(BMagenta),
		"B_CYAN":    eclaType.String(BCyan),
		"B_WHITE":   eclaType.String(BWhite),

		"U_BLACK":   eclaType.String(UBlack),
		"U_RED":     eclaType.String(URed),
		"U_GREEN":   eclaType.String(UGreen),
		"U_YELLOW":  eclaType.String(UYellow),
		"U_BLUE":    eclaType.String(UBlue),
		"U_MAGENTA": eclaType.String(UMagenta),
		"U_CYAN":    eclaType.String(UCyan),
		"U_WHITE":   eclaType.String(UWhite),

		"ON_BLACK":   eclaType.String(On_Black),
		"ON_RED":     eclaType.String(On_Red),
		"ON_GREEN":   eclaType.String(On_Green),
		"ON_YELLOW":  eclaType.String(On_Yellow),
		"ON_BLUE":    eclaType.String(On_Blue),
		"ON_MAGENTA": eclaType.String(On_Magenta),
		"ON_CYAN":    eclaType.String(On_Cyan),
		"ON_WHITE":   eclaType.String(On_White),

		"I_BLACK":   eclaType.String(IBlack),
		"I_RED":     eclaType.String(IRed),
		"I_GREEN":   eclaType.String(IGreen),
		"I_YELLOW":  eclaType.String(IYellow),
		"I_BLUE":    eclaType.String(IBlue),
		"I_MAGENTA": eclaType.String(IMagenta),
		"I_CYAN":    eclaType.String(ICyan),
		"I_WHITE":   eclaType.String(IWhite),

		"BI_BLACK":   eclaType.String(BIBlack),
		"BI_RED":     eclaType.String(BIRed),
		"BI_GREEN":   eclaType.String(BIGreen),
		"BI_YELLOW":  eclaType.String(BIYellow),
		"BI_BLUE":    eclaType.String(BIBlue),
		"BI_MAGENTA": eclaType.String(BIMagenta),
		"BI_CYAN":    eclaType.String(BICyan),
		"BI_WHITE":   eclaType.String(BIWhite),

		"ONI_BLACK":   eclaType.String(On_IBlack),
		"ONI_RED":     eclaType.String(On_IRed),
		"ONI_GREEN":   eclaType.String(On_IGreen),
		"ONI_YELLOW":  eclaType.String(On_IYellow),
		"ONI_BLUE":    eclaType.String(On_IBlue),
		"ONI_MAGENTA": eclaType.String(On_IMagenta),
		"ONI_CYAN":    eclaType.String(On_ICyan),
		"ONI_WHITE":   eclaType.String(On_IWhite),
	}
)

Colors constants

Functions ¶

func Clear ¶

func Clear()

Clear clears the console

func Input ¶

func Input() string

Input takes user input from console and returns a string

func InputFloat ¶

func InputFloat() (float64, error)

InputFloat takes user input from console and returns a float64

func InputInt ¶

func InputInt() (int, error)

InputInt takes user input from console and returns an int

func Print ¶

func Print(args ...any)

Print prints args to console

func PrintInColor ¶

func PrintInColor(color string, args ...any)

PrintInColor prints args to console in color

func Printf ¶

func Printf(format string, args ...any)

Printf prints args to console formatted with format

func Println ¶

func Println(args ...any)

Println prints args to console with a newline

func SPrint ¶ added in v1.1.0

func SPrint(args ...any) string

func SPrintf ¶ added in v1.1.0

func SPrintf(format string, args ...any) string

func SPrintln ¶ added in v1.1.0

func SPrintln(args ...any) string

Types ¶

This section is empty.

Source Files ¶

View all Source files

console.go

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