Class ValidatingJsonConverter<TValue, TPrimitive>

Namespace

Trellis.Asp.Validation

Assembly

Trellis.Asp.dll

A JSON converter for value objects that implement IScalarValue<TSelf, TPrimitive>. This converter collects validation errors instead of throwing exceptions, enabling comprehensive validation error responses.

public sealed class ValidatingJsonConverter<TValue, TPrimitive> : ScalarValueJsonConverterBase<TValue?, TValue, TPrimitive> where TValue : class, IScalarValue<TValue, TPrimitive> where TPrimitive : IComparable

Type Parameters

TValue

The type of the value object to convert.

TPrimitive

The underlying primitive type.

Inheritance

object

JsonConverter

JsonConverter<TValue>

ScalarValueJsonConverterBase<TValue, TValue, TPrimitive>

ValidatingJsonConverter<TValue, TPrimitive>

Inherited Members

ScalarValueJsonConverterBase<TValue, TValue, TPrimitive>.HandleNull

ScalarValueJsonConverterBase<TValue, TValue, TPrimitive>.Read(ref Utf8JsonReader, Type, JsonSerializerOptions)

JsonConverter<TValue>.CanConvert(Type)

JsonConverter<TValue>.Read(ref Utf8JsonReader, Type, JsonSerializerOptions)

JsonConverter<TValue>.ReadAsPropertyName(ref Utf8JsonReader, Type, JsonSerializerOptions)

JsonConverter<TValue>.WriteAsPropertyName(Utf8JsonWriter, TValue, JsonSerializerOptions)

JsonConverter<TValue>.HandleNull

JsonConverter<TValue>.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MaybeExtensions.AsMaybe<T>(T)

MaybeExtensions.ToResult<TValue>(TValue)

NullableExtensions.ToResult<T>(T?, Func<Error>)

NullableExtensions.ToResult<T>(T?, Error)

AggregateTestMutator.ClearMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>)

AggregateTestMutator.SetMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>, TValue?)

Remarks

This converter enables the pattern where DTOs can contain value objects directly, and all validation errors are collected during deserialization rather than failing on the first invalid value.

When a value fails validation:

• The error is added to ValidationErrorsContext
• A default value (null) is returned
• Deserialization continues to collect additional errors

After deserialization, use ScalarValueValidationFilter to check for errors and return appropriate 400 Bad Request responses.

Methods

OnNullToken(string)

Returns the result when a JSON null token is read.

protected override TValue? OnNullToken(string fieldName)

Parameters

fieldName string

The resolved field name for error reporting.

Returns

TValue

OnValidationFailure()

Returns the result when validation fails.

protected override TValue? OnValidationFailure()

Returns

TValue

WrapSuccess(TValue)

Wraps a successfully validated value object into the result type.

protected override TValue? WrapSuccess(TValue value)

Parameters

value TValue

Returns

TValue

Write(Utf8JsonWriter, TValue?, JsonSerializerOptions)

Writes a specified value as JSON.

[UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "TPrimitive type parameter is preserved by JSON serialization infrastructure")]
[UnconditionalSuppressMessage("AOT", "IL3050", Justification = "JSON serialization of primitive types is compatible with AOT")]
public override void Write(Utf8JsonWriter writer, TValue? value, JsonSerializerOptions options)

Parameters

writer Utf8JsonWriter

The writer to write to.

value TValue

The value to convert to JSON.

options JsonSerializerOptions

An object that specifies serialization options to use.