Safe Haskell	None
Language	Haskell2010

System.Console.AsciiProgress

Synopsis

Documentation

data ProgressBar Source

Constructors

ProgressBar
Fields pgInfo :: ProgressBarInfo pgFuture :: Async ()

data Options Source

The progress bar's options.

Constructors

Options

Fields

pgFormat :: String: A format string for the progress bar. Currently the following format strings are supported: - ":eta" (ETA displayed in seconds) - ":current" (current tick) - ":total" (total number of ticks) - ":percent" (percentage completed) - ":elapsed" (elapsed time in seconds) - ":bar" (the actual progress bar)
pgCompletedChar :: Char: Character to be used on the completed part of the bar
pgPendingChar :: Char: Character to be used on the pending part of the bar
pgTotal :: Int: Total amount of ticks expected
pgWidth :: Int: The progress bar's width
pgOnCompletion :: IO (): An IO action to be executed on completion, with the cursor set at progress bar's line

Instances

Default Options

data Stats Source

Represents a point in time for the progress bar.

Constructors

Stats
Fields stTotal :: Int stCompleted :: Int stRemaining :: Int stElapsed :: Double stPercent :: Double stEta :: Double

isComplete :: ProgressBar -> IO Bool Source

Returns if the progress bar rendering thread has exited (it has done enough ticks)

newProgressBar :: Options -> IO ProgressBar Source

Creates a new progress bar with the given Options. Multiple progress bars may be created as long as everytime a line is outputted by your program, while progress bars run is followed by a call to registerLn

complete :: ProgressBar -> IO () Source

Forces a ProgressBar to finish

tick :: ProgressBar -> IO () Source

Tick the progress bar

tickN :: ProgressBar -> Int -> IO () Source

Tick the progress bar N times

getProgressStrIO :: ProgressBar -> IO String Source

Like getProgressStr but works on the ProgressBar object and uses the IO monad.

getProgressStats :: ProgressBar -> IO Stats Source

Gets the progress bar current Stats object

getProgressStr :: Options -> Stats -> String Source

Gets the string to be printed given the options object and a certain stats object representing the rendering moment.

registerLn :: IO () Source

Registers a new line for multiple progress bars

class Default a where

A class for types with a default value.

Methods

def :: a

The default value for this type.

Instances

Default Double
Default Float
Default Int
Default Int8
Default Int16
Default Int32
Default Int64
Default Integer
Default Ordering
Default Word
Default Word8
Default Word16
Default Word32
Default Word64
Default ()
Default All
Default Any
Default IntSet
Default TimeLocale
Default Options
Default [a]
Integral a => Default (Ratio a)
Default a => Default (IO a)
(Default a, RealFloat a) => Default (Complex a)
Default a => Default (Dual a)
Default (Endo a)
Num a => Default (Sum a)
Num a => Default (Product a)
Default (First a)
Default (Last a)
Default (Maybe a)
Default (IntMap v)
Default (Set v)
Default a => Default (Tree a)
Default (Seq a)
Default (DList a)
Default r => Default (e -> r)
(Default a, Default b) => Default (a, b)
Default (Map k v)
(Default a, Default b, Default c) => Default (a, b, c)
(Default a, Default b, Default c, Default d) => Default (a, b, c, d)
(Default a, Default b, Default c, Default d, Default e) => Default (a, b, c, d, e)
(Default a, Default b, Default c, Default d, Default e, Default f) => Default (a, b, c, d, e, f)
(Default a, Default b, Default c, Default d, Default e, Default f, Default g) => Default (a, b, c, d, e, f, g)