amorfo77/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2026-06-17 22:24:17 +00:00
Code Issues Projects Releases Wiki Activity

ui: unexport json and text progress

Browse Source
This commit is contained in:
Michael Eischer
2026-06-05 14:28:09 +02:00
parent 37fdbe5779
commit c04f3e9d6c
2 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/ui/backup/json.go
+14 -14
View File
@@ -10,8 +10,8 @@ import (
"github.com/restic/restic/internal/ui/progress"
)
// JSONProgress reports progress for the `backup` command in JSON.
type JSONProgress struct {
// jsonProgress reports progress for the `backup` command in JSON.
type jsonProgress struct {
progress.Printer
term ui.Terminal
@@ -19,27 +19,27 @@ type JSONProgress struct {
}
// assert that Backup implements the ProgressPrinter interface
var _ ProgressPrinter = &JSONProgress{}
var _ ProgressPrinter = &jsonProgress{}
// NewJSONProgress returns a new backup progress reporter.
func NewJSONProgress(term ui.Terminal, verbosity uint) *JSONProgress {
return &JSONProgress{
func NewJSONProgress(term ui.Terminal, verbosity uint) ProgressPrinter {
return &jsonProgress{
Printer: ui.NewProgressPrinter(true, verbosity, term),
term: term,
v: verbosity,
}
}
func (b *JSONProgress) print(status interface{}) {
func (b *jsonProgress) print(status interface{}) {
b.term.Print(ui.ToJSONString(status))
}
func (b *JSONProgress) error(status interface{}) {
func (b *jsonProgress) error(status interface{}) {
b.term.Error(ui.ToJSONString(status))
}
// Update updates the status lines.
func (b *JSONProgress) Update(total, processed Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) {
func (b *jsonProgress) Update(total, processed Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) {
status := statusUpdate{
MessageType: "status",
SecondsElapsed: uint64(time.Since(start) / time.Second),
@@ -65,7 +65,7 @@ func (b *JSONProgress) Update(total, processed Counter, errors uint, currentFile
// ScannerError is the error callback function for the scanner, it prints the
// error in verbose mode and returns nil.
func (b *JSONProgress) ScannerError(item string, err error) error {
func (b *jsonProgress) ScannerError(item string, err error) error {
b.error(errorUpdate{
MessageType: "error",
Error: errorObject{err.Error()},
@@ -76,7 +76,7 @@ func (b *JSONProgress) ScannerError(item string, err error) error {
}
// Error is the error callback function for the archiver, it prints the error and returns nil.
func (b *JSONProgress) Error(item string, err error) error {
func (b *jsonProgress) Error(item string, err error) error {
b.error(errorUpdate{
MessageType: "error",
Error: errorObject{err.Error()},
@@ -88,7 +88,7 @@ func (b *JSONProgress) Error(item string, err error) error {
// CompleteItem is the status callback function for the archiver when a
// file/dir has been saved successfully.
func (b *JSONProgress) CompleteItem(messageType, item string, s archiver.ItemStats, d time.Duration) {
func (b *jsonProgress) CompleteItem(messageType, item string, s archiver.ItemStats, d time.Duration) {
if b.v < 2 {
return
}
@@ -150,7 +150,7 @@ func (b *JSONProgress) CompleteItem(messageType, item string, s archiver.ItemSta
}
// ReportTotal sets the total stats up to now
func (b *JSONProgress) ReportTotal(start time.Time, s archiver.ScanStats) {
func (b *jsonProgress) ReportTotal(start time.Time, s archiver.ScanStats) {
if b.v >= 2 {
b.print(verboseUpdate{
MessageType: "verbose_status",
@@ -163,7 +163,7 @@ func (b *JSONProgress) ReportTotal(start time.Time, s archiver.ScanStats) {
}
// Finish prints the finishing messages.
func (b *JSONProgress) Finish(snapshotID restic.ID, summary *archiver.Summary, dryRun bool) {
func (b *jsonProgress) Finish(snapshotID restic.ID, summary *archiver.Summary, dryRun bool) {
id := ""
// empty if snapshot creation was skipped
if !snapshotID.IsNull() {
@@ -192,7 +192,7 @@ func (b *JSONProgress) Finish(snapshotID restic.ID, summary *archiver.Summary, d
}
// Reset no-op
func (b *JSONProgress) Reset() {
func (b *jsonProgress) Reset() {
}
type statusUpdate struct {
internal/ui/backup/text.go
+12 -12
View File
@@ -11,8 +11,8 @@ import (
"github.com/restic/restic/internal/ui/progress"
)
// TextProgress reports progress for the `backup` command.
type TextProgress struct {
// textProgress reports progress for the `backup` command.
type textProgress struct {
progress.Printer
term ui.Terminal
@@ -20,11 +20,11 @@ type TextProgress struct {
}
// assert that Backup implements the ProgressPrinter interface
var _ ProgressPrinter = &TextProgress{}
var _ ProgressPrinter = &textProgress{}
// NewTextProgress returns a new backup progress reporter.
func NewTextProgress(term ui.Terminal, verbosity uint) *TextProgress {
return &TextProgress{
func NewTextProgress(term ui.Terminal, verbosity uint) ProgressPrinter {
return &textProgress{
Printer: ui.NewProgressPrinter(false, verbosity, term),
term: term,
verbosity: verbosity,
@@ -32,7 +32,7 @@ func NewTextProgress(term ui.Terminal, verbosity uint) *TextProgress {
}
// Update updates the status lines.
func (b *TextProgress) Update(total, processed Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) {
func (b *textProgress) Update(total, processed Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) {
var status string
if total.Files == 0 && total.Dirs == 0 {
// no total count available yet
@@ -74,7 +74,7 @@ func (b *TextProgress) Update(total, processed Counter, errors uint, currentFile
// ScannerError is the error callback function for the scanner, it prints the
// error in verbose mode and returns nil.
func (b *TextProgress) ScannerError(_ string, err error) error {
func (b *textProgress) ScannerError(_ string, err error) error {
if b.verbosity >= 2 {
b.E("scan: %v\n", err)
}
@@ -82,14 +82,14 @@ func (b *TextProgress) ScannerError(_ string, err error) error {
}
// Error is the error callback function for the archiver, it prints the error and returns nil.
func (b *TextProgress) Error(_ string, err error) error {
func (b *textProgress) Error(_ string, err error) error {
b.E("error: %v\n", err)
return nil
}
// CompleteItem is the status callback function for the archiver when a
// file/dir has been saved successfully.
func (b *TextProgress) CompleteItem(messageType, item string, s archiver.ItemStats, d time.Duration) {
func (b *textProgress) CompleteItem(messageType, item string, s archiver.ItemStats, d time.Duration) {
item = ui.Quote(item)
switch messageType {
@@ -115,7 +115,7 @@ func (b *TextProgress) CompleteItem(messageType, item string, s archiver.ItemSta
}
// ReportTotal sets the total stats up to now
func (b *TextProgress) ReportTotal(start time.Time, s archiver.ScanStats) {
func (b *textProgress) ReportTotal(start time.Time, s archiver.ScanStats) {
b.V("scan finished in %.3fs: %v files, %s",
time.Since(start).Seconds(),
s.Files, ui.FormatBytes(s.Bytes),
@@ -123,14 +123,14 @@ func (b *TextProgress) ReportTotal(start time.Time, s archiver.ScanStats) {
}
// Reset status
func (b *TextProgress) Reset() {
func (b *textProgress) Reset() {
if b.term.CanUpdateStatus() {
b.term.SetStatus(nil)
}
}
// Finish prints the finishing messages.
func (b *TextProgress) Finish(id restic.ID, summary *archiver.Summary, dryRun bool) {
func (b *textProgress) Finish(id restic.ID, summary *archiver.Summary, dryRun bool) {
b.P("\n")
b.P("Files: %5d new, %5d changed, %5d unmodified\n", summary.Files.New, summary.Files.Changed, summary.Files.Unchanged)
b.P("Dirs: %5d new, %5d changed, %5d unmodified\n", summary.Dirs.New, summary.Dirs.Changed, summary.Dirs.Unchanged)