TheArchive/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2025-12-12 08:31:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

ui: document Message / Printer / Terminal interfaces

Browse Source
This commit is contained in:
Michael Eischer
2025-09-21 16:32:00 +02:00
parent 2fe271980f
commit 86ddee8518
3 changed files with 29 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
internal/ui/progress/printer.go
View File

@@ -6,18 +6,27 @@ import "testing"
// at different log levels.
// It must be safe to call its methods from concurrent goroutines.
type Printer interface {
// NewCounter returns a new progress counter. It is not shown if --quiet or --json is specified.
NewCounter(description string) *Counter
// NewCounterTerminalOnly returns a new progress counter that is only shown if stdout points to a
// terminal. It is not shown if --quiet or --json is specified.
NewCounterTerminalOnly(description string) *Counter
// E prints to stderr
// E reports an error. This message is always printed to stderr.
// Appends a newline if not present.
E(msg string, args ...interface{})
// S prints to stdout
// S prints a message, this is should only be used for very important messages
// that are not errors. The message is even printed if --quiet is specified.
// Appends a newline if not present.
S(msg string, args ...interface{})
// P prints to stdout unless quiet was passed
// P prints a message if verbosity >= 1 (neither --quiet nor --verbose is specified),
// this is used for normal messages which are not errors. Appends a newline if not present.
P(msg string, args ...interface{})
// V prints to stdout if verbose is set once
// V prints a message if verbosity >= 2 (equivalent to --verbose), this is used for
// verbose messages. Appends a newline if not present.
V(msg string, args ...interface{})
// VV prints to stdout if verbose is set twice
// VV prints a message if verbosity >= 3 (equivalent to --verbose=2), this is used for
// debug messages. Appends a newline if not present.
VV(msg string, args ...interface{})
}