plexus library

Classes

AnsiCode
Standard ANSI escape code for customizing terminal text output. [...]
AnsiCodeType
The type of code represented by AnsiCode.
AuthEvent<B>
An implementation of Event representing a change in authentication state
Country
A representation of a country
Event<B>
An event which will be logged by a Logger's individual handlers. [...]
IHasBlob<B>
Represents a class holding a blob of type B
IHasError
Represents a class holding an error and optional stacktrace
IHasIsInit
Represents a class holding a state of init or not init
IHasLevel
Represents a class holding a level
IHasLongMessage
Represents a class holding a long message
IHasShortMessage
Represents a class holding a message
IHasSource
Represents a class holding a source
IHasTimestamp
Represents a class holding a timestamp
IHasZone
Represents a class holding a zone
ILog
Implemented by any class that wants to support Plexus logging operations.
IndexingOperatorWrapper<K, V>
Implements indexing behaviour in the form of retrieval by, setting by, and removal by keys
Language
A representation of a language
LanguageBase
A template for a representation of a language or locale
Level
Levels to control logging output. Logging can be enabled to include all levels above certain Level. Levels are ordered using an integer value Level.value. The predefined Level constants below are sorted as follows (in descending order): Level.SHOUT, Level.SEVERE, Level.WARNING, Level.INFO, Level.CONFIG, Level.FINE, Level.FINER, Level.FINEST, and Level.ALL. [...]
ListOperatorWrapper<E>
Implements List indexing behaviour in the form of retrieval by, setting by, and removal by int keys
Locale
A representation of a locale consisting of a language and, optionally, a country.
Localization
A set of localized messages/formats/etc. for locale
Localizations
A set of Localization for supportedLanguages
Module
The base module class. The default implementation is StdModule.
Nullable
When used to annotate a field/parameter, that field/parameter is able to store a null value (prior to NNBD)
OperatorWrapper
Base class for basic operator wrappers
PatientStreamQueue<E>
A stream that waits for its first listener before emitting events. [...]
RequestInputEvent<B>
An implementation of Event representing a request for user input
RootModule
There is a single RootModule instance, which should only be managed (setting level, etc.) by the final product (i.e. Flutter app (not library) or CLI (seperated from api)) and should be accessed statically outside this library.
StdEvent<B>
The default implementation of Event
StdModule
The standard Module implementation. [...]

Mixins

HasModule
ModuleCommon

Extensions

ExtIterable
Provides extension functions on Iterable with element type String
ExtString
Provides extension functions for String

Constants

formsOfYes → const Set<String>
Various ridiculous letter combinations that can be accepted as "yes" in English.
const {'yup', 'yes', 'sure', 'ye', 'yeet', 'yet', 'yep', 'yop', 'why not', 'y not', 'y', 'you betcha', &…
nullable → const Nullable
When used to annotate a field/parameter, that field/parameter is able to store a null value (prior to NNBD)
const Nullable._()

Properties

iso8601NoTZ DateFormat
A DateFormat implementing ISO 8601 without timezone
final
stdinLined Stream<String>
Wrapper around stdinUtf8 splitting at line endings
final
stdinUtf8 Stream<String>
Wrapper around sharedStdin providing each character as a String
final
userHome Directory
The user's home directory
read-only
whitespacePattern RegExp
A RegExp pattern for all horizontal whitespace characters,
final

Functions

asyncVoidEventHandler(dynamic _) FutureOr<void>
Placeholder asynchronous event handler
asyncVoidHandler() Future<void>
Placeholder asynchronous callback
consoleHandler(dynamic event, [Stdout out]) → void
A handler for Plexus modules that formats and forwards all event to out [...]
loopback<T>(T t) → T
Can be used to bypass a parse function.
printSpaced(dynamic value, {bool leadingNewline: false, bool trailingNewline: true}) → void
Prints value using the native print method, optionally appending and prepending newlines to value.
prompt<T>(String question, {T fallback, T def, String hint, T parse(String), bool echo: true, bool debug: false}) Future<T>
Prompts the user through the console with question. [...]
promptFor({String prompt, String promptSuffix: ' >>> ', bool echo: true}) String
Prompts the user to enter anything, with the option of not echoing stdin to stdout.
promptSync<T>(String question, {T fallback, String hint, T parse(String), bool echo: true, bool debug: false}) → T
Prompts the user through the console with question. [...]
shouldPrompt(String question, [bool def = true, bool fallback = false]) Future<bool>
Prompts the user through the console with question and returns their yes or no response.
shouldPromptSync(String question, [bool def = true]) bool
Prompts the user through the console with question and returns their yes or no response.
voidEventHandler(dynamic _) → void
Placeholder event handler
voidHandler() → void
Placeholder callback

Enums

AuthSignal
A representation of authentication state changes
State
A representation of various common states

Typedefs

Callback<R>() → R
A template for a standalone callback that returns a particular R [...]
EventHandler(Event event) → void
A function that handles Event
FutureOrCallback<R>() FutureOr<R>
A template for an optionally-asynchronous standalone callback that returns a particular R [...]
FutureOrValue2Callback<V1, V2, R>(V1 value1, V2 value2) FutureOr<R>
A template for an optionally-asynchronous callback that returns a particular R when given a particular V1 and V2
FutureOrValue3Callback<V1, V2, V3, R>(V1 value1, V2 value2, V3 value3) FutureOr<R>
A template for an optionally-asynchronous callback that returns a particular R when given a particular V1, V2 and V3
FutureOrValueCallback<V1, R>(V1 value1) FutureOr<R>
A template for an optionally-asynchronous callback that returns a particular R when given a particular V1
FutureOrValueTest<V>(V value) FutureOr<bool>
A template for an optionally-asynchronous callback that tests a value of type V
InputTest(List<String> context, String input) bool
Represents a test used to validate user input given context representing past input and input.
ModuleBuilder(List<String> package, Level level) Module
A function used to generate a Module
Value2Callback<V1, V2, R>(V1 value1, V2 value2) → R
A template for a callback that returns a particular R when given a particular V1 and V2
Value3Callback<V1, V2, V3, R>(V1 value1, V2 value2, V3 value3) → R
A template for a callback that returns a particular R when given a particular V1, V2 and V3
ValueCallback<V1, R>(V1 value1) → R
A template for a callback that returns a particular R when given a particular V
ValueTest<V>(V value) bool
A template for a callback that tests a value of type V