module Molinillo::UI

Overview

Conveys information about the resolution process to a user.

Defined in:

molinillo/modules/ui.cr

Instance Method Summary

Instance Method Detail

def after_resolution #

Called after resolution ends (either successfully or with an error). By default, prints a newline.

@return [void]


[View source]
def before_resolution #

Called before resolution begins.

@return [void]


[View source]
def debug(depth = 0, &) #

Conveys debug information to the user.

@param [Integer] depth the current depth of the resolution process. @return [void]


[View source]
def debug? #

Whether or not debug messages should be printed. By default, whether or not the MOLINILLO_DEBUG environment variable is set.

@return [Boolean]


[View source]
def indicate_progress #

Called roughly every {#progress_rate}, this method should convey progress to the user.

@return [void]


[View source]
def output #

The {IO} object that should be used to print output. STDOUT, by default.

@return [IO]


[View source]
def progress_rate #

How often progress should be conveyed to the user via {#indicate_progress}, in seconds. A third of a second, by default.

@return [Float]


[View source]