summaryrefslogtreecommitdiffstats
path: root/dependencies/pkg/mod/github.com/vbauerster/mpb/v6@v6.0.4/example_test.go
diff options
context:
space:
mode:
Diffstat (limited to 'dependencies/pkg/mod/github.com/vbauerster/mpb/v6@v6.0.4/example_test.go')
-rw-r--r--dependencies/pkg/mod/github.com/vbauerster/mpb/v6@v6.0.4/example_test.go84
1 files changed, 84 insertions, 0 deletions
diff --git a/dependencies/pkg/mod/github.com/vbauerster/mpb/v6@v6.0.4/example_test.go b/dependencies/pkg/mod/github.com/vbauerster/mpb/v6@v6.0.4/example_test.go
new file mode 100644
index 0000000..6f25c1b
--- /dev/null
+++ b/dependencies/pkg/mod/github.com/vbauerster/mpb/v6@v6.0.4/example_test.go
@@ -0,0 +1,84 @@
+package mpb_test
+
+import (
+ crand "crypto/rand"
+ "io"
+ "io/ioutil"
+ "math/rand"
+ "time"
+
+ "github.com/vbauerster/mpb/v6"
+ "github.com/vbauerster/mpb/v6/decor"
+)
+
+func Example() {
+ // initialize progress container, with custom width
+ p := mpb.New(mpb.WithWidth(64))
+
+ total := 100
+ name := "Single Bar:"
+ // adding a single bar, which will inherit container's width
+ bar := p.Add(int64(total),
+ // progress bar filler with customized style
+ mpb.NewBarFiller("╢▌▌░╟"),
+ mpb.PrependDecorators(
+ // display our name with one space on the right
+ decor.Name(name, decor.WC{W: len(name) + 1, C: decor.DidentRight}),
+ // replace ETA decorator with "done" message, OnComplete event
+ decor.OnComplete(
+ // ETA decorator with ewma age of 60, and width reservation of 4
+ decor.EwmaETA(decor.ET_STYLE_GO, 60, decor.WC{W: 4}), "done",
+ ),
+ ),
+ mpb.AppendDecorators(decor.Percentage()),
+ )
+ // simulating some work
+ max := 100 * time.Millisecond
+ for i := 0; i < total; i++ {
+ // start variable is solely for EWMA calculation
+ // EWMA's unit of measure is an iteration's duration
+ start := time.Now()
+ time.Sleep(time.Duration(rand.Intn(10)+1) * max / 10)
+ bar.Increment()
+ // we need to call DecoratorEwmaUpdate to fulfill ewma decorator's contract
+ bar.DecoratorEwmaUpdate(time.Since(start))
+ }
+ // wait for our bar to complete and flush
+ p.Wait()
+}
+
+func ExampleBar_Completed() {
+ p := mpb.New()
+ bar := p.AddBar(100)
+
+ max := 100 * time.Millisecond
+ for !bar.Completed() {
+ time.Sleep(time.Duration(rand.Intn(10)+1) * max / 10)
+ bar.Increment()
+ }
+
+ p.Wait()
+}
+
+func ExampleBar_ProxyReader() {
+ // import crand "crypto/rand"
+
+ var total int64 = 1024 * 1024 * 500
+ reader := io.LimitReader(crand.Reader, total)
+
+ p := mpb.New()
+ bar := p.AddBar(total,
+ mpb.AppendDecorators(
+ decor.CountersKibiByte("% .2f / % .2f"),
+ ),
+ )
+
+ // create proxy reader
+ proxyReader := bar.ProxyReader(reader)
+ defer proxyReader.Close()
+
+ // and copy from reader, ignoring errors
+ io.Copy(ioutil.Discard, proxyReader)
+
+ p.Wait()
+}