1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
// Copyright 2020 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package progress
import (
"encoding/json"
"fmt"
"strings"
)
// Mode determines how the progress bar is rendered
type Mode int
const (
// ModeSpinner renders a Spinner
ModeSpinner Mode = iota
// ModeProgress renders a ProgressBar. Not supported yet.
ModeProgress
// ModeDone renders as "Done" message.
ModeDone
// ModeError renders as "Error" message.
ModeError
)
// MarshalJSON implements JSON marshaler
func (m Mode) MarshalJSON() ([]byte, error) {
var s string
switch m {
case ModeSpinner:
s = "running"
case ModeProgress:
s = "progress"
case ModeDone:
s = "done"
case ModeError:
s = "error"
default:
s = "unknown"
}
return json.Marshal(s)
}
// UnmarshalJSON implements JSON unmarshaler
func (m *Mode) UnmarshalJSON(b []byte) error {
var s string
if err := json.Unmarshal(b, &s); err != nil {
return err
}
switch strings.ToLower(s) {
case "spinner", "running": // keep "spinner" for compatibility
*m = ModeSpinner
case "progress":
*m = ModeProgress
case "done":
*m = ModeDone
case "error":
*m = ModeError
default:
panic("unknown mode")
}
return nil
}
// String implements string
func (m Mode) String() string {
var s string
switch m {
case ModeSpinner:
s = "running"
case ModeProgress:
s = "progress"
case ModeDone:
s = "done"
case ModeError:
s = "error"
default:
s = "unknown"
}
return s
}
// DisplayProps controls the display of the progress bar.
type DisplayProps struct {
Prefix string `json:"prefix,omitempty"`
Suffix string `json:"suffix,omitempty"` // If `Mode == Done / Error`, Suffix is not printed
Mode Mode `json:"mode,omitempty"`
Detail string `json:"detail,omitempty"`
}
// String implements string
func (dp *DisplayProps) String() string {
return fmt.Sprintf(
"(%s) %s: %s",
dp.Mode,
dp.Prefix,
dp.Suffix,
)
}
|
