Skip to main content

ISuggestsWords interface

Namespace: Arlecchino.Editing · Assembly: Arlecchino

Where the words a half-typed one could turn into come from. It is asked rather than read, since the answer can be a folder on the far side of a network.

public interface ISuggestsWords

Implemented by WordList

Methods

MemberSummary
SuggestAsync(CompletionAsk, CancellationToken)What the word being typed could still turn into.

Methods in detail

SuggestAsync(CompletionAsk, CancellationToken)

public ValueTask<IReadOnlyList<string>> SuggestAsync(CompletionAsk ask, CancellationToken token);

What the word being typed could still turn into.

Parameters

NameTypeDescription
askCompletionAskThe word and the line it stands in.
tokenCancellationTokenGives up the wait, as it is given up when the line is typed into again.

Returns ValueTask<TResult><IReadOnlyList<T><string>> — The words, the likeliest first, or nothing when the word can go nowhere.