utils

package

v1.2.14 Latest Latest Go to latest Published: Dec 28, 2025 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tanq16/anbu

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func FDebug(text string) string
func FError(text string) string
func FInfo(text string) string
func FStream(text string) string
func FSuccess(text string) string
func FWarning(text string) string
func PrintDebug(text string)
func PrintError(text string)
func PrintInfo(text string)
func PrintProgressBar(current, total int64, width int) string
func PrintStream(text string)
func PrintSuccess(text string)
func PrintWarning(text string)
type Dictionary
- func (d Dictionary) UnwindBool(keys ...string) bool
- func (d Dictionary) UnwindInt(keys ...string) int
- func (d Dictionary) UnwindString(keys ...string) string
- func (d Dictionary) UnwindValue(keys ...string) any
type ErrorReport
type FunctionOutput
type Manager
- func NewManager() *Manager
- func (m *Manager) AddProgressBarToStream(name string, outof, final int64, text string)
- func (m *Manager) ClearAll()
- func (m *Manager) Complete(name, message string)
- func (m *Manager) GetStatusIndicator(status string) string
- func (m *Manager) Register(name string) string
- func (m *Manager) RegisterTable(name string, headers []string) *Table
- func (m *Manager) ReportError(name string, err error)
- func (m *Manager) SetMessage(name, message string)
- func (m *Manager) ShowSummary()
- func (m *Manager) StartDisplay()
- func (m *Manager) StopDisplay()
type Table
- func NewTable(headers []string) *Table
- func (t *Table) FormatTable(useMarkdown bool) string
- func (t *Table) PrintTable(useMarkdown bool)

Constants ¶

This section is empty.

Variables ¶

View Source

var GlobalDebugFlag bool

View Source

var StyleSymbols = map[string]string{
	"pass":    "✓",
	"fail":    "✗",
	"warning": "!",
	"pending": "◉",
	"info":    "ℹ",
	"arrow":   "→",
	"bullet":  "•",
	"dot":     "·",
	"hline":   "━",
}

Functions ¶

func FDebug ¶ added in v0.2.11

func FDebug(text string) string

func FError ¶ added in v0.2.11

func FError(text string) string

func FInfo ¶ added in v0.2.11

func FInfo(text string) string

func FStream ¶ added in v0.2.11

func FStream(text string) string

func FSuccess ¶ added in v0.2.11

func FSuccess(text string) string

func FWarning ¶ added in v0.2.11

func FWarning(text string) string

func PrintDebug ¶ added in v0.2.11

func PrintDebug(text string)

func PrintError ¶ added in v0.2.11

func PrintError(text string)

func PrintInfo ¶ added in v0.2.11

func PrintInfo(text string)

func PrintProgressBar ¶ added in v0.2.11

func PrintProgressBar(current, total int64, width int) string

func PrintStream ¶ added in v0.2.11

func PrintStream(text string)

func PrintSuccess ¶ added in v0.2.11

func PrintSuccess(text string)

func PrintWarning ¶ added in v0.2.11

func PrintWarning(text string)

Types ¶

type Dictionary ¶ added in v0.0.2

type Dictionary map[string]any

func (Dictionary) UnwindBool ¶ added in v0.0.2

func (d Dictionary) UnwindBool(keys ...string) bool

func (Dictionary) UnwindInt ¶ added in v0.0.2

func (d Dictionary) UnwindInt(keys ...string) int

func (Dictionary) UnwindString ¶ added in v0.0.2

func (d Dictionary) UnwindString(keys ...string) string

func (Dictionary) UnwindValue ¶ added in v0.0.2

func (d Dictionary) UnwindValue(keys ...string) any

UnwindValue safely navigates and retrieves values from nested maps

type ErrorReport ¶ added in v0.2.11

type ErrorReport struct {
	FunctionName string
	Error        error
	Time         time.Time
}

type FunctionOutput ¶ added in v0.2.11

type FunctionOutput struct {
	Name        string
	Status      string
	Message     string
	StreamLines []string
	Complete    bool
	StartTime   time.Time
	LastUpdated time.Time
	Error       error
	Index       int
}

type Manager ¶ added in v0.2.11

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

func NewManager ¶ added in v0.2.11

func NewManager() *Manager

func (*Manager) AddProgressBarToStream ¶ added in v0.2.11

func (m *Manager) AddProgressBarToStream(name string, outof, final int64, text string)

func (*Manager) ClearAll ¶ added in v0.2.11

func (m *Manager) ClearAll()

func (*Manager) Complete ¶ added in v0.2.11

func (m *Manager) Complete(name, message string)

func (*Manager) GetStatusIndicator ¶ added in v0.2.11

func (m *Manager) GetStatusIndicator(status string) string

func (*Manager) Register ¶ added in v0.2.11

func (m *Manager) Register(name string) string

func (*Manager) RegisterTable ¶ added in v0.2.11

func (m *Manager) RegisterTable(name string, headers []string) *Table

Add a global table

func (*Manager) ReportError ¶ added in v0.2.11

func (m *Manager) ReportError(name string, err error)

func (*Manager) SetMessage ¶ added in v0.2.11

func (m *Manager) SetMessage(name, message string)

func (*Manager) ShowSummary ¶ added in v0.2.11

func (m *Manager) ShowSummary()

func (*Manager) StartDisplay ¶ added in v0.2.11

func (m *Manager) StartDisplay()

func (*Manager) StopDisplay ¶ added in v0.2.11

func (m *Manager) StopDisplay()

type Table ¶ added in v0.2.11

type Table struct {
	Headers []string
	Rows    [][]string
	// contains filtered or unexported fields
}

func NewTable ¶ added in v0.2.11

func NewTable(headers []string) *Table

func (*Table) FormatTable ¶ added in v0.2.11

func (t *Table) FormatTable(useMarkdown bool) string

func (*Table) PrintTable ¶ added in v0.2.11

func (t *Table) PrintTable(useMarkdown bool)

Source Files ¶

View all Source files

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