Class DateTimeInRange

A validation rule which passes if the validated System.DateTime or System.Nullable<T> DateTime is within an inclusive Start & End range.

Inheritance
System.Object
DateTimeInRange
Implements
IRuleWithMessage<System.DateTime>
IRule<System.DateTime>
IGetsFailureMessage<System.DateTime>
IRuleWithMessage<System.Nullable<System.DateTime>>
IRule<System.Nullable<System.DateTime>>
IGetsFailureMessage<System.Nullable<System.DateTime>>
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 DateTimeInRange : IRuleWithMessage<DateTime>, IRule<DateTime>, IGetsFailureMessage<DateTime>, IRuleWithMessage<DateTime?>, IRule<DateTime?>, IGetsFailureMessage<DateTime?>
Remarks

Either of Start or End may be null. If either is null then either the start or end of the range will not be used (which means that this becomes simply a "before" or "after" validation rule). If both ends of the range are null then this validation rule will always pass.

This validation rule may additionally be used with System.Nullable<T> DateTime instances, in which case this rule will pass if the validated value is null. Combine this rule with a NotNull rule if null DateTimes are not permitted.

The logic of this rule does not verify that the Start is not later-than the End. Thus it is possible to set up scenarios where this rule will always return a failure result for any DateTime, as the pass criteria cannot be satisfied.

This rule will always return a synchronous result.

Properties

| Improve this Doc View Source

End

Gets or sets the (inclusive) end System.DateTime for validating DateTimes.

Declaration
public DateTime? End { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

Start

Gets or sets the (inclusive) start System.DateTime for validating DateTimes.

Declaration
public DateTime? Start { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Methods

| Improve this Doc View Source

GetFailureMessageAsync(Nullable<DateTime>, ValidationRuleResult, CancellationToken)

Gets the validation failure message for the specified result.

Declaration
public ValueTask<string> GetFailureMessageAsync(DateTime? value, ValidationRuleResult result, CancellationToken token = default(CancellationToken))
Parameters
Type Name Description
System.Nullable<System.DateTime> 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(DateTime, RuleContext, CancellationToken)

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

Declaration
public ValueTask<RuleResult> GetResultAsync(DateTime validated, RuleContext context, CancellationToken token = default(CancellationToken))
Parameters
Type Name Description
System.DateTime 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
| Improve this Doc View Source

GetResultAsync(Nullable<DateTime>, RuleContext, CancellationToken)

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

Declaration
public ValueTask<RuleResult> GetResultAsync(DateTime? validated, RuleContext context, CancellationToken token = default(CancellationToken))
Parameters
Type Name Description
System.Nullable<System.DateTime> 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<DateTime>.GetFailureMessageAsync(DateTime, ValidationRuleResult, CancellationToken)

Declaration
ValueTask<string> IGetsFailureMessage<DateTime>.GetFailureMessageAsync(DateTime value, ValidationRuleResult result, CancellationToken token)
Parameters
Type Name Description
System.DateTime value
ValidationRuleResult result
System.Threading.CancellationToken token
Returns
Type Description
System.Threading.Tasks.ValueTask<System.String>

Implements