core.utilities

Package core.utilities

Types

ANSIProgressRenderer object ANSIProgressRenderer

Knows how to render a ProgressTracker to the terminal using coloured, emoji-fied output. Useful when writing small command line tools, demos, tests etc. Just set the progressTracker field and it will go ahead and start drawing if the terminal supports it. Otherwise it just prints out the name of the step whenever it changes.

BriefLogFormatter class BriefLogFormatter : Formatter

A Java logging formatter that writes more compact output than the default.

Emoji object Emoji

A simple wrapper class that contains icons and support for printing them only when were connected to a terminal.

ProgressTracker class ProgressTracker

A progress tracker helps surface information about the progress of an operation to a user interface or API of some kind. It lets you define a set of steps that represent an operation. A step is represented by an object (typically a singleton).

UntrustworthyData class UntrustworthyData<T>

A small utility to approximate taint tracking: if a method gives you back one of these, it means the data came from a remote source that may be incentivised to pass us junk that violates basic assumptions and thus must be checked first. The wrapper helps you to avoid forgetting this vital step. Things you might want to check are:

Functions

loggerFor fun <T : Any> loggerFor(): <ERROR CLASS>
trace fun <ERROR CLASS>.trace(msg: () -> String): Unit