Class CollectionItemValueMustValidateCompatibleTypeForValidatedType
A rule which asserts that - where the OwnCollectionItemValue is not null, it is configured to validate a type (via its own ValidatedType property) that is compatible with the generic type for which the current ValidatedType implements System.Collections.Generic.IEnumerable<T>.
Inheritance
Inherited Members
Namespace: CSF.Validation.Rules
Assembly: CSF.Validation.StandardRules.dll
Syntax
public class CollectionItemValueMustValidateCompatibleTypeForValidatedType : IRuleWithMessage<ManifestItem>, IRule<ManifestItem>, IGetsFailureMessage<ManifestItem>Examples
For example, if (from the validated manifest item) item.CollectionItemValue.ValidatedType is equal to typeof(Pet)
and also item.ValidatedType derives from either IEnumerable<Cat> or IEnumerable<Pet> (where
Cat is a subclass of Pet) then this would pass validation.
On the other hand, if item.CollectionItemValue.ValidatedType is typeof(Cat)
but item.ValidatedType derives from only IEnumerable<Pet> then this rule would fail validation.
That's because if the collection may contain any "Pet", then it can't be validated by a ManifestItem
which is only capable of validating "Cat" instances.
Methods
| Improve this Doc View SourceGetFailureMessageAsync(ManifestItem, ValidationRuleResult, CancellationToken)
Gets the validation failure message for the specified result.
Declaration
public ValueTask<string> GetFailureMessageAsync(ManifestItem value, ValidationRuleResult result, CancellationToken token = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| ManifestItem | 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. |
GetResultAsync(ManifestItem, RuleContext, CancellationToken)
Performs the validation logic asynchronously and returns a task of RuleResult.
Declaration
public ValueTask<RuleResult> GetResultAsync(ManifestItem validated, RuleContext context, CancellationToken token = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| ManifestItem | 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 |