Class VerbDescriptor

Namespace

RDCore.SDK.Platform.Commands

Assembly

RDCore.SDK.dll

A verb of a platform application, and the forms its arguments take: what a client or a server needs to know of it to complete it as it is typed, and to describe it - without running it.

public sealed record VerbDescriptor : IEquatable<VerbDescriptor>

Inheritance

object

VerbDescriptor

Implements

IEquatable<VerbDescriptor>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A verb has one form or several: BREAK alone, BREAK CLEAR, BREAK TOGGLE <line>, BREAK <line> [condition]. A form is its arguments in the order they are written; a form whose arguments are fewer than what is typed is not the one that is being written, and an argument that takes the rest of the line is the last of its form.

The descriptor is data: it travels where the verb does not - with a completion request (Command) - and is all that is needed to complete its arguments (VerbCompletion).

Properties

Aliases

The other spellings of the verb.

public IReadOnlyList<string> Aliases { get; init; }

Property Value

IReadOnlyList<string>

Forms

The forms the arguments of the verb take, each its arguments in the order they are written; none for a verb that takes no arguments.

public IReadOnlyList<IReadOnlyList<VerbArgument>> Forms { get; init; }

Property Value

IReadOnlyList<IReadOnlyList<VerbArgument>>

Name

The verb, as it is written.

public string Name { get; init; }

Property Value

string

Summary

What the verb does, in a sentence.

public string Summary { get; init; }

Property Value

string