OptionValuesCompletionResult class

A CompletionResult that suggests the values of an option given its optionName and its completionLevel.

For options with Option.allowed values, the suggestions will be those values with Option.allowedHelp as description.

If pattern is not null, only the values that start with the pattern will be suggested.

Use OptionValuesCompletionResult.isAbbr to suggest the values of an option in an abbreviated form.

Inheritance

Constructors

OptionValuesCompletionResult({required CompletionLevel completionLevel, required String optionName, String? pattern}): A CompletionResult that suggests the values of an option given its optionName and its completionLevel.
const
OptionValuesCompletionResult.abbr({required CompletionLevel completionLevel, required String abbrName, String? pattern, bool includeAbbrName = false}): A CompletionResult that suggests the values of an option given its optionName and its completionLevel.
const

completionLevel → CompletionLevel: The CompletionLevel in which the suggested option is supposed to be located at.
final
completions → Map<String, String?>: A collection of MapEntry with completion suggestions to their descriptions.
no setteroverride
hashCode → int: The hash code for this object.
no setterinherited
includeAbbrName → bool: Whether the option name should be included in the suggestions. This is only used when isAbbr is true.
final
isAbbr → bool: Whether the option name is abbreviated.
final
optionName → String: The name of the option whose values will be suggested.
final
pattern → String?: The pattern in which the matching options values be suggested.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited