InputValidationResult
Returns the outcome of an input check without executing a command.
- Kind:
Class - Namespace: Repl
- Assembly:
Repl.Core - Source: src/Repl.Core/Input/InputValidationResult.cs
Signature
Section titled “Signature”public sealed class InputValidationResultInheritance
Section titled “Inheritance”Constructors
Section titled “Constructors”InputValidationResult(InputValidationState, IReadOnlyList<InputDiagnostic>?)
Section titled “InputValidationResult(InputValidationState, IReadOnlyList<InputDiagnostic>?)”Creates a result with optional diagnostics.
public InputValidationResult(InputValidationState state, IReadOnlyList<InputDiagnostic>? diagnostics = null)Parameters
Section titled “Parameters”state(InputValidationState): Overall validation state.diagnostics(IReadOnlyList<InputDiagnostic>): Messages from the check.
Methods
Section titled “Methods”Incomplete(string, InputSourceRange?)
Section titled “Incomplete(string, InputSourceRange?)”Reports that more input or another check is needed.
public static InputValidationResult Incomplete(string message, InputSourceRange? range = null)Parameters
Section titled “Parameters”message(string): Explanation of what is missing.range(InputSourceRange): Optional original input range.
Returns
Section titled “Returns”Invalid(string, InputSourceRange?)
Section titled “Invalid(string, InputSourceRange?)”Rejects input with a diagnostic.
public static InputValidationResult Invalid(string message, InputSourceRange? range = null)Parameters
Section titled “Parameters”message(string): Reason for rejection.range(InputSourceRange): Optional original input range.
Returns
Section titled “Returns”Valid()
Section titled “Valid()”Returns successful validation.
public static InputValidationResult Valid()Returns
Section titled “Returns”Properties
Section titled “Properties”Diagnostics
Section titled “Diagnostics”Gets the messages returned by the check.
public IReadOnlyList<InputDiagnostic> Diagnostics { get; }Returns
Section titled “Returns”IReadOnlyList<InputDiagnostic>
Gets the overall state, including any more severe diagnostic.
public InputValidationState State { get; }