Class ScalarValueJsonConverterBase<TResult, TValue, TPrimitive>

Namespace

Trellis.Asp.Validation

Assembly

Trellis.Asp.dll

Base JSON converter for scalar value objects that collects validation errors instead of throwing exceptions during deserialization.

public abstract class ScalarValueJsonConverterBase<TResult, TValue, TPrimitive> : JsonConverter<TResult> where TValue : class, IScalarValue<TValue, TPrimitive> where TPrimitive : IComparable

Type Parameters

TResult

The result type of deserialization (e.g., TValue? or Maybe<TValue>).

TValue

The scalar value object type.

TPrimitive

The underlying primitive type.

Inheritance

object

JsonConverter

JsonConverter<TResult>

ScalarValueJsonConverterBase<TResult, TValue, TPrimitive>

Derived

MaybeScalarValueJsonConverter<TValue, TPrimitive>

ValidatingJsonConverter<TValue, TPrimitive>

Inherited Members

JsonConverter<TResult>.CanConvert(Type)

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

JsonConverter<TResult>.Write(Utf8JsonWriter, TResult, JsonSerializerOptions)

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

JsonConverter<TResult>.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

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?)

Properties

HandleNull

Tells System.Text.Json to call Read(ref Utf8JsonReader, Type, JsonSerializerOptions) even when the JSON token is null. Without this, the serializer bypasses the converter for null tokens on reference-type results, preventing OnNullToken(string) from firing.

public override bool HandleNull { get; }

Property Value

bool

Methods

GetDefaultFieldName()

Gets the default field name derived from the value object type name.

protected static string GetDefaultFieldName()

Returns

string

OnNullToken(string)

Returns the result when a JSON null token is read.

protected abstract TResult OnNullToken(string fieldName)

Parameters

fieldName string

The resolved field name for error reporting.

Returns

TResult

OnValidationFailure()

Returns the result when validation fails.

protected abstract TResult OnValidationFailure()

Returns

TResult

Read(ref Utf8JsonReader, Type, JsonSerializerOptions)

Reads and converts the JSON to type T.

[UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "TPrimitive type parameter is preserved by JSON serialization infrastructure")]
[UnconditionalSuppressMessage("AOT", "IL3050", Justification = "JSON deserialization of primitive types is compatible with AOT")]
public override TResult Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Parameters

reader Utf8JsonReader

The reader.

typeToConvert Type

The type to convert.

options JsonSerializerOptions

An object that specifies serialization options to use.

Returns

TResult

The converted value.

WrapSuccess(TValue)

Wraps a successfully validated value object into the result type.

protected abstract TResult WrapSuccess(TValue value)

Parameters

value TValue

Returns

TResult