Interface IArgumentType

Defines command argument parsing and completion behavior.

public interface IArgumentType : IAnyArgumentType

Properties

Gets representative valid input strings.

IEnumerable<string> Examples { get; }

Casts this argument type to a requested argument interface or implementation.

T As<T>() where T : IAnyArgumentType

This instance cast to T.

T

The target argument type.

This instance is not assignable to T.

Lists completions for this argument type.

ValueTask<Suggestions> ListSuggestionsAsync(CommandContext context, SuggestionsBuilder builder, CancellationToken cancellationToken)

The parsed command context.

The suggestion builder.

cancellationToken CancellationToken

A token that may cancel asynchronous providers.

The suggestions; the default implementation returns .

Parses a value from the reader’s current cursor.

IArgumentValue Parse(StringReader reader)

The command reader to consume.

The parsed argument value.