update doc comments
Vladimir Bauer
4 years ago
| 8 | 8 | // BarFiller interface. |
| 9 | 9 | // Bar (without decorators) renders itself by calling BarFiller's Fill method. |
| 10 | 10 | // |
| 11 | // reqWidth is requested width, set by `func WithWidth(int) ContainerOption`. | |
| 11 | // reqWidth is requested width set by `func WithWidth(int) ContainerOption`. | |
| 12 | 12 | // If not set, it defaults to terminal width. |
| 13 | // | |
| 14 | // Default implementations can be obtained via: | |
| 15 | // | |
| 16 | // func NewBarFiller(BarStyle()) BarFiller | |
| 17 | // func NewBarFiller(SpinnerStyle()) BarFiller | |
| 18 | 13 | // |
| 19 | 14 | type BarFiller interface { |
| 20 | 15 | Fill(w io.Writer, reqWidth int, stat decor.Statistics) |
| 21 | 16 | } |
| 22 | 17 | |
| 23 | 18 | // BarFillerBuilder interface. |
| 19 | // Default implementations are: | |
| 20 | // | |
| 21 | // BarStyle() | |
| 22 | // SpinnerStyle() | |
| 23 | // NopStyle() | |
| 24 | // | |
| 24 | 25 | type BarFillerBuilder interface { |
| 25 | 26 | Build() BarFiller |
| 26 | 27 | } |