CompletionResult class abstract

Describes the result of a completion handling process.

Generated after parsing a completion request from the shell, it is responsible to contain the information to be sent back to the shell (via stdout) including suggestions and its metadata (description).

See also:

• AllOptionsAndCommandsCompletionResult
• AllAbbrOptionsCompletionResult
• MatchingCommandsCompletionResult
• MatchingOptionsCompletionResult
• OptionValuesCompletionResult

Implementers

• AllAbbrOptionsCompletionResult
• AllOptionsAndCommandsCompletionResult
• MatchingCommandsCompletionResult
• MatchingOptionsCompletionResult
• OptionValuesCompletionResult

Annotations

• @immutable

Constructors

CompletionResult()

Describes the result of a completion handling process.

const

Properties

completions → Map<String, String?>

A collection of MapEntry with completion suggestions to their descriptions.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited