Class MustBeDefinedEnumConstant<T>

A validation rule which asserts that the validated value (which may be nullable) is a defined member of the specified enumerated type.

Inheritance
System.Object
MustBeDefinedEnumConstant<T>
Implements
IRuleWithMessage<System.Nullable<T>>
IRule<System.Nullable<T>>
IGetsFailureMessage<System.Nullable<T>>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: CSF.Validation.Rules
Assembly: CSF.Validation.StandardRules.dll
Syntax
public class MustBeDefinedEnumConstant<T> : IRuleWithMessage<T>, IRule<T>, IGetsFailureMessage<T>, IRuleWithMessage<T?>, IRule<T?>, IGetsFailureMessage<T?> where T : struct, Enum
Type Parameters
Name Description
T

The type of the enum against which to verify that the validated value is a defined member.
Remarks

This validation rule is also compatible with nullable values of T, and will return a passing result if the validated value is null.

Methods

| Improve this Doc View Source

GetFailureMessageAsync(Nullable<T>, ValidationRuleResult, CancellationToken)

Gets the validation failure message for the specified result.

Declaration
public ValueTask<string> GetFailureMessageAsync(T? value, ValidationRuleResult result, CancellationToken token = default(CancellationToken))
Parameters
Type Name Description
System.Nullable<T> value
ValidationRuleResult result

A validation result, typically indicating failure.
System.Threading.CancellationToken token

An optional cancellation token.
Returns
Type Description
System.Threading.Tasks.ValueTask<System.String>

A human-readable message.
| Improve this Doc View Source

GetResultAsync(Nullable<T>, RuleContext, CancellationToken)

Performs the validation logic asynchronously and returns a task of RuleResult.

Declaration
public ValueTask<RuleResult> GetResultAsync(T? validated, RuleContext context, CancellationToken token = default(CancellationToken))
Parameters
Type Name Description
System.Nullable<T> validated
RuleContext context

Contextual information about the validation
System.Threading.CancellationToken token

An object which may be used to cancel the process
Returns
Type Description
System.Threading.Tasks.ValueTask<RuleResult>

A task which provides a result object, indicating the result of validation
Remarks

This method receives the value to be validated as well as an object which represents the context in which this rule is running. It should return a task of RuleResult.

In order to create the result object, particularly if your rule logic will run synchronously, consider using the CommonResults class via using static CSF.Validation.Rules.CommonResults; in your rule logic. The common results class has helper methods such as PassAsync(IDictionary<String, Object>) and FailAsync(IDictionary<String, Object>) which include optimisations for flyweight task instances that avoid allocating additional resources needlessly.

It is acceptable to throw an uncaught exception from this method, as the validation framework will catch it and automatically convert it into an error result. Generally, developers do not need to manually return a result of outcome Errored manually. This would be appropriate only in an unusual scenario that is considered an error, but which does not involve the throwing of an exception. Error results are generally harder for the consumer to deal with than failure results.

The context parameter may be used, amongst other things, to access 'ancestor' values. However, if this rule only needs access to an immediate parent value then consider using IRule<TValue, TParent> instead.

Exceptions
Type Condition
System.Exception

This method may raise any exception type

Explicit Interface Implementations

| Improve this Doc View Source

IGetsFailureMessage<T>.GetFailureMessageAsync(T, ValidationRuleResult, CancellationToken)

Declaration
ValueTask<string> IGetsFailureMessage<T>.GetFailureMessageAsync(T value, ValidationRuleResult result, CancellationToken token)
Parameters
Type Name Description
T value
ValidationRuleResult result
System.Threading.CancellationToken token
Returns
Type Description
System.Threading.Tasks.ValueTask<System.String>
| Improve this Doc View Source

IRule<T>.GetResultAsync(T, RuleContext, CancellationToken)

Declaration
ValueTask<RuleResult> IRule<T>.GetResultAsync(T validated, RuleContext context, CancellationToken token)
Parameters
Type Name Description
T validated
RuleContext context
System.Threading.CancellationToken token
Returns
Type Description
System.Threading.Tasks.ValueTask<RuleResult>

Implements