Xrefcheck.Progress

Printing progress bars.

Progress

data Progress a

Processing progress of any thing.

Constructors

Progress

Fields

• pCurrent :: a

  How much has been completed.

• pTotal :: a

  Overall amount of work.

• pErrors :: !a

  How many of the completed work finished with an error.

Instances

Show a => Show (Progress a)

Defined in Xrefcheck.Progress

Methods

showsPrec :: Int -> Progress a -> ShowS

show :: Progress a -> String

showList :: [Progress a] -> ShowS

initProgress :: Num a => a -> Progress a

Initialise null progress.

incProgress :: (Num a, Show a) => Progress a -> Progress a

Increase progress amount.

incProgressErrors :: (Num a, Show a) => Progress a -> Progress a

Increase errors amount.

showProgress :: Text -> Int -> Color -> Progress Int -> Text

Visualise progress bar.

Printing

data Rewrite

Passing this object allows returning caret and replace text in line. Only functions which has this thing can do that because being interleaved with putTextLn printing caret symbol produced garbage.

allowRewrite :: (MonadIO m, MonadMask m) => Bool -> (Rewrite -> m a) -> m a

Provide context for rewrite operations.

putTextRewrite :: MonadIO m => Rewrite -> Text -> m ()

Return caret and print the given text.