Class AllPolymorphicTypesMustBeMarkedAsSo

A rule that asserts all members of the PolymorphicTypes collection have the value type PolymorphicType.

Inheritance

System.Object

AllPolymorphicTypesMustBeMarkedAsSo

Implements

IRuleWithMessage<ManifestItem>

IRule<ManifestItem>

IGetsFailureMessage<ManifestItem>

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 AllPolymorphicTypesMustBeMarkedAsSo : IRuleWithMessage<ManifestItem>, IRule<ManifestItem>, IGetsFailureMessage<ManifestItem>

Methods

GetFailureMessageAsync(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

Implements

IRuleWithMessage<TValidated>

IRule<TValidated>

IGetsFailureMessage<TValidated>