glitzer - v1.2.0

glitzer/progress

Types

Char

opaque

A String with only one character.

pub opaque type Char

ProgressStyle

opaque

The style of a progress bar.

pub opaque type ProgressStyle

State

opaque 
pub opaque type State

Functions

char_from_string 

pub fn char_from_string(from in: String) -> Char

Create a Char from a String. Returns a Char with the given string if the strings length is equal to one and a Char of “#” otherwise.

Example: 
import glitzer/progress

fn example() {
  let char = progress.char_from_string("A")
}

default_bar 

pub fn default_bar() -> ProgressStyle

Create and return a default progress bar.

each_iterator 

pub fn each_iterator(
  over i: Iterator(a),
  bar bar: ProgressStyle,
  with fun: fn(ProgressStyle, a) -> b,
) -> Nil

Deprecated: `each_iterator` was deprecated and will be removed in the next release. Use `each_yielder` instead.

each_yielder 

pub fn each_yielder(
  over y: Yielder(a),
  bar bar: ProgressStyle,
  with fun: fn(ProgressStyle, a) -> b,
) -> Nil

fancy_slim_arrow_bar 

pub fn fancy_slim_arrow_bar() -> ProgressStyle

Create and return a fancy and slim progress bar with an arrow head.

fancy_slim_bar 

pub fn fancy_slim_bar() -> ProgressStyle

Create and return a fancy and slim progress bar (inspired by pip).

fancy_thick_bar 

pub fn fancy_thick_bar() -> ProgressStyle

Create and return a fancy thick bar.

finish 

pub fn finish(bar bar: ProgressStyle) -> ProgressStyle

Completely fill the progress bar.

map2_iterator 

pub fn map2_iterator(
  iterator1 i1: Iterator(a),
  iterator2 i2: Iterator(b),
  bar bar: ProgressStyle,
  with fun: fn(ProgressStyle, a, b) -> c,
) -> Iterator(c)

Deprecated: `map2_iterator` was deprecated and will be removed in the next release. Use `map2_yielder` instead.

map2_yielder 

pub fn map2_yielder(
  yielder1 y1: Yielder(a),
  yielder2 y2: Yielder(b),
  bar bar: ProgressStyle,
  with fun: fn(ProgressStyle, a, b) -> c,
) -> Yielder(c)

map_iterator 

pub fn map_iterator(
  over i: Iterator(a),
  bar bar: ProgressStyle,
  with fun: fn(ProgressStyle, a) -> b,
) -> Iterator(b)

Deprecated: `map_iterator` was deprecated and will be removed in the next release. Use `map_yielder` instead.

Map an iterator to a function with a bar that ticks every run of the function.

Example: 
import glitzer/progress

fn example(bar) {
  iterator.range(0, 100)
  |> progress.map_iterator(fn(bar, element) {
    progress.print_bar(bar)
    // do some heavy calculations here >:)
  })
}

map_yielder 

pub fn map_yielder(
  over y: Yielder(a),
  bar bar: ProgressStyle,
  with fun: fn(ProgressStyle, a) -> b,
) -> Yielder(b)

Map a yielder to a function with a bar that ticks every run of the function.

Example: 
import glitzer/progress

fn example(bar) {
  yielder.range(0, 100)
  |> progress.map_yielder(fn(bar, element) {
    progress.print_bar(bar)
    // do some heavy calculations here >:)
  })
}

new_bar 

pub fn new_bar() -> ProgressStyle

Create a new (completely empty) progress bar.

Example: 
import glitzer/progress

fn example() {
  let bar = 
    progress.new_bar()
    |> progress.with_length(50)
    |> progress.with_left_text("Progress: ")
    |> progress.with_fill(progress.char_from_string("+"))
}

pub fn print_bar(bar bar: ProgressStyle) -> Nil

Print the progress bar to stderr.

Example: 
import glitzer/progress

fn example() {
  let bar = progress.default_bar()

  run_example(bar, 0)
}

fn run_example(bar, count) {
  case count < 100 {
    True -> {
      let bar = progress.tick(bar)
      // do some awesome stuff :3
      progress.print_bar(bar)
      run_example(bar, count + 1)
    }
    False -> Nil
  }
}

slim_bar 

pub fn slim_bar() -> ProgressStyle

Create and return a fancy and slim progress bar (inspired by pip).

string_from_char 

pub fn string_from_char(from in: Char) -> String

Create a String from a given Char.

thick_bar 

pub fn thick_bar() -> ProgressStyle

Create and return a thick bar.

tick 

pub fn tick(bar bar: ProgressStyle) -> ProgressStyle

Increase the progress of the bar by one.

tick_by 

pub fn tick_by(bar bar: ProgressStyle, i i: Int) -> ProgressStyle

Increase the progress of the bar by i.

with_empty 

pub fn with_empty(
  bar bar: ProgressStyle,
  empty char: Char,
) -> ProgressStyle

Add a character to a progress bar that is used to represent the “background” of the bar.

with_fill 

pub fn with_fill(
  bar bar: ProgressStyle,
  fill char: Char,
) -> ProgressStyle

Add a character to a progress bar that is used to fill the bar on each tick.

with_fill_finished 

pub fn with_fill_finished(
  bar bar: ProgressStyle,
  fill char: Char,
) -> ProgressStyle

Add a character that will be used instead of fill if the bar is finished.

with_fill_head 

pub fn with_fill_head(
  bar bar: ProgressStyle,
  fill char: Char,
) -> ProgressStyle

Add a head to the progress bar.

with_fill_head_finished 

pub fn with_fill_head_finished(
  bar bar: ProgressStyle,
  fill char: Char,
) -> ProgressStyle

Add a head to the progress bar that will be displayed when the bar finishes.

with_left_text 

pub fn with_left_text(
  bar bar: ProgressStyle,
  left text: String,
) -> ProgressStyle

Add left text to a progress bar.

with_length 

pub fn with_length(
  bar bar: ProgressStyle,
  length len: Int,
) -> ProgressStyle

Add length to a progress bar.

with_right_text 

pub fn with_right_text(
  bar bar: ProgressStyle,
  right text: String,
) -> ProgressStyle

Add right text to a progress bar.

✨ Search Document