Class LengthInRange

A rule that passes if a validated array, collection or string is either null or has a length/count of items between inclusive minimum/maximums, configured in this rule.

Inheritance
System.Object
LengthInRange
Implements
IRuleWithMessage<System.Array>
IRule<System.Array>
IGetsFailureMessage<System.Array>
IRuleWithMessage<System.Collections.ICollection>
IRule<System.Collections.ICollection>
IGetsFailureMessage<System.Collections.ICollection>
IRuleWithMessage<System.String>
IRule<System.String>
IGetsFailureMessage<System.String>
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 LengthInRange : IRuleWithMessage<Array>, IRule<Array>, IGetsFailureMessage<Array>, IRuleWithMessage<ICollection>, IRule<ICollection>, IGetsFailureMessage<ICollection>, IRuleWithMessage<string>, IRule<string>, IGetsFailureMessage<string>
Remarks

Either of the Min or Max properties may be null, in which case they are ignored and not used. If either are null then this rule becomes effectively "shorter/fewer than" or "longer/more than". If both are null then this rull becomes meaningless; it will always pass. This rule will also pass if the array, collection or string itself is null.

The logic of this rule does not verify that the Mininum length is not greater-than the Maximum length, or that neither of these values is negative. Thus it is possible to set up scenarios where this rule will always return a failure result for any non-null collection, as the pass criteria cannot be satisfied.

This rule will always return a synchronous result.

Constructors

| Improve this Doc View Source

LengthInRange(IntegerInRange)

Initialises a new instance of LengthInRange.

Declaration
public LengthInRange(IntegerInRange inRangeRule)
Parameters
Type Name Description
IntegerInRange inRangeRule

A number-in-range rule.
Exceptions
Type Condition
System.ArgumentNullException

If inRangeRule is null.

Properties

| Improve this Doc View Source

Max

Gets or sets the maximum inclusive length (or count of items).

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

Min

Gets or sets the minimum inclusive length (or count of items).

Declaration
public int? Min { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Methods

| Improve this Doc View Source

GetFailureMessageAsync(Array, ValidationRuleResult, CancellationToken)

Gets the validation failure message for the specified result.

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

GetFailureMessageAsync(ICollection, ValidationRuleResult, CancellationToken)

Gets the validation failure message for the specified result.

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

GetFailureMessageAsync(String, ValidationRuleResult, CancellationToken)

Gets the validation failure message for the specified result.

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

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

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

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

Declaration
public ValueTask<RuleResult> GetResultAsync(ICollection validated, RuleContext context, CancellationToken token = default(CancellationToken))
Parameters
Type Name Description
System.Collections.ICollection 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(String, RuleContext, CancellationToken)

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

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

Implements