Struct PreconditionResult
- Namespace
- Signal.Application.Commands.Preconditions
- Assembly
- Signal.Application.dll
Outcome of a precondition check.
public readonly record struct PreconditionResult : IEquatable<PreconditionResult>
- Implements
- Inherited Members
Constructors
PreconditionResult(bool, string?)
Outcome of a precondition check.
public PreconditionResult(bool IsSuccess, string? Reason)
Parameters
IsSuccessboolWhether the command may run.
ReasonstringA user-facing reason on failure; null fails silently.
Properties
IsSuccess
Whether the command may run.
public bool IsSuccess { get; init; }
Property Value
Reason
A user-facing reason on failure; null fails silently.
public string? Reason { get; init; }
Property Value
Success
The check passed.
public static PreconditionResult Success { get; }
Property Value
Methods
Fail(string?)
The check failed.
public static PreconditionResult Fail(string? reason)
Parameters
Returns
- PreconditionResult
The result.