ProgressBar

trait ProgressBar[F[_]]
Companion:
object
class Object
trait Matchable
class Any

Value members

Abstract methods

def current: F[Long]

Returns the current progress.

Returns the current progress.

def extraMessage: F[String]

Returns the extra message at the end of the progress bar.

Returns the extra message at the end of the progress bar.

def max: F[Long]

Returns the maximum value of this progress bar.

Returns the maximum value of this progress bar.

def maxHint(n: Long): F[Unit]

Gives a hint to the maximum value of the progress bar.

Gives a hint to the maximum value of the progress bar.

Value parameters:
n

Hint of the maximum value. A value of -1 indicates that the progress bar is indefinite.

def pause: F[Unit]

Pauses this current progress.

Pauses this current progress.

def pipe[A]: (F, A) => A

Increments the progress bar with the index of the stream element currently being processed.

Increments the progress bar with the index of the stream element currently being processed.

def refresh: F[Unit]

Prompts the progress bar to refresh. Normally a user should not call this function.

Prompts the progress bar to refresh. Normally a user should not call this function.

def reset: F[Unit]

Resets the progress bar to its initial state (where progress equals to 0).

Resets the progress bar to its initial state (where progress equals to 0).

def resume: F[Unit]

Resumes this current progress.

Resumes this current progress.

def setExtraMessage(msg: String): F[Unit]

Sets the extra message at the end of the progress bar.

Sets the extra message at the end of the progress bar.

Value parameters:
msg

New message

def step: F[Unit]

Advances this progress bar by one step.

Advances this progress bar by one step.

def stepBy(n: Long): F[Unit]

Advances this progress bar by a specific amount.

Advances this progress bar by a specific amount.

Value parameters:
n

Step size

def stepTo(n: Long): F[Unit]

Advances this progress bar to the specific progress value.

Advances this progress bar to the specific progress value.

Value parameters:
n

New progress value

def taskName: F[String]

Returns the name of this task.

Returns the name of this task.