Fast.Serialization.System.Text.Json public API

Targets: net8.0;net9.0;net10.0. This is a declaration and XML-comment reference. See the module guide for usage and constraints.

Source commit: 43554c07f6c216f80b509bd535c0a5b66ae7f2e8. Maintained through scripts/export-dotnet-api.ps1 -Language en; ordinary site builds consume this file directly.

Fast.Serialization.JsonContext

Source · Targets: net8.0, net9.0, net10.0

public static class JsonContext

System.Text.Json serialization context

Fast.Serialization.JsonContext.SerializerOptions

Source · Targets: net8.0, net9.0, net10.0

public static JsonSerializerOptions SerializerOptions { get; internal set; }

System.Text.Json serialization options

Fast.Serialization.IServiceCollectionExtension

Source · Targets: net8.0, net9.0, net10.0

public static class IServiceCollectionExtension

Provides System.Text.Json extensions for IServiceCollection

Fast.Serialization.IServiceCollectionExtension.AddSerialization

Source · Targets: net8.0, net9.0, net10.0

public static IServiceCollection AddSerialization(this IServiceCollection services,
        Action<JsonOptions> configureOptions = null)

Adds System.Text.Json serialization services

• Parameter services: The service collection to add services to
• Parameter configureOptions: JSON configuration callback
• Returns: Returns services for chaining

Fast.Serialization.SerializationExtension

Source · Targets: net8.0, net9.0, net10.0

public static class SerializationExtension

Provides System.Text.Json serialization extensions

Fast.Serialization.SerializationExtension.ToObject

Source · Targets: net8.0, net9.0, net10.0

public static T ToObject<T>(this string json)

Deserializes JSON text into an object

• Parameter json: JSON text to parse
• Type parameter T: Type of the serialized or converted object
• Returns: Converted object

Fast.Serialization.SerializationExtension.ToObject

Source · Targets: net8.0, net9.0, net10.0

public static object ToObject(this string json, Type type)

Deserializes JSON text into an object

• Parameter json: JSON text to parse
• Parameter type: Target type
• Returns: Converted object

Fast.Serialization.SerializationExtension.ToJsonString

Source · Targets: net8.0, net9.0, net10.0

public static string ToJsonString(this object obj)

Serializes an object into JSON text

• Parameter obj: Object to process
• Returns: Serialized JSON text

Fast.Serialization.SerializationExtension.ToObject

Source · Targets: net8.0, net9.0, net10.0

public static T ToObject<T>(this IDictionary<string, object> dictionary)

Converts dictionary data into an object

• Parameter dictionary: Dictionary to process
• Type parameter T: Type of the serialized or converted object
• Returns: Converted object

Fast.Serialization.SerializationExtension.ToObject

Source · Targets: net8.0, net9.0, net10.0

public static object ToObject(this IDictionary<string, object> dictionary, Type type)

Converts dictionary data into an object

• Parameter dictionary: Dictionary to process
• Parameter type: Target type
• Returns: Converted object

Fast.Serialization.SerializationExtension.DeepCopy

Source · Targets: net8.0, net9.0, net10.0

public static T DeepCopy<T>(this T source)

Creates a deep copy through JSON serialization

Remarks: Creates a copy through one serialization/deserialization round trip. This costs more than member copying and preserves only serializable data

• Parameter source: Object to copy
• Type parameter T: Type of the object to copy
• Returns: Created object copy

Fast.Serialization.DataMaskingTypeEnum

Source · Targets: net8.0, net9.0, net10.0

public enum DataMaskingTypeEnum

Data masking type enum

Fast.Serialization.DataMaskingTypeEnum.Name

Source · Targets: net8.0, net9.0, net10.0

Name

Name

Fast.Serialization.DataMaskingTypeEnum.NameKeepLast

Source · Targets: net8.0, net9.0, net10.0

NameKeepLast

Name, preserving the first and last characters

Fast.Serialization.DataMaskingTypeEnum.Account

Source · Targets: net8.0, net9.0, net10.0

Account

Account

Fast.Serialization.DataMaskingTypeEnum.Mobile

Source · Targets: net8.0, net9.0, net10.0

Mobile

Mobile number

Fast.Serialization.DataMaskingTypeEnum.IdCard

Source · Targets: net8.0, net9.0, net10.0

IdCard

Identity card number

Fast.Serialization.DataMaskingTypeEnum.Email

Source · Targets: net8.0, net9.0, net10.0

Email

Email

Fast.Serialization.DataMaskingTypeEnum.BankCard

Source · Targets: net8.0, net9.0, net10.0

BankCard

Bank card number

Fast.Serialization.DataMaskingTypeEnum.Address

Source · Targets: net8.0, net9.0, net10.0

Address

Address

Fast.Serialization.DataMaskingTypeEnum.CarNumber

Source · Targets: net8.0, net9.0, net10.0

CarNumber

License plate number

Fast.Serialization.DataMaskingTypeEnum.Ip

Source · Targets: net8.0, net9.0, net10.0

Ip

IP address

Fast.Serialization.DataMaskingConverter

Source · Targets: net8.0, net9.0, net10.0

public class DataMaskingConverter : JsonConverter<string>

Masks data in JSON responses

Fast.Serialization.DataMaskingConverter.MaskingType

Source · Targets: net8.0, net9.0, net10.0

public DataMaskingTypeEnum MaskingType { get; set; }

Data masking type

Fast.Serialization.DataMaskingConverter.DataMaskingConverter

Source · Targets: net8.0, net9.0, net10.0

public DataMaskingConverter(DataMaskingTypeEnum maskingType)

Masks data in JSON responses

• Parameter maskingType: Data masking method

Fast.Serialization.DataMaskingConverter.Read

Source · Targets: net8.0, net9.0, net10.0

public override string Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.DataMaskingConverter.Write

Source · Targets: net8.0, net9.0, net10.0

public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.DateJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public class DateJsonConverter : JsonConverter<DateTime>

Date formatting for DateTime values in JSON responses

Fast.Serialization.DateJsonConverter.Format

Source · Targets: net8.0, net9.0, net10.0

public string Format { get; set; }

Date format; defaults to yyyy-MM-dd

Fast.Serialization.DateJsonConverter.DateJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public DateJsonConverter()

Date formatting for DateTime values in JSON responses

Fast.Serialization.DateJsonConverter.DateJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public DateJsonConverter(string format)

Date formatting for DateTime values in JSON responses

• Parameter format: Date/time format

Fast.Serialization.DateJsonConverter.Read

Source · Targets: net8.0, net9.0, net10.0

public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.DateJsonConverter.Write

Source · Targets: net8.0, net9.0, net10.0

public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.NullableDateJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public class NullableDateJsonConverter : JsonConverter<DateTime?>

Date formatting for nullable DateTime values in JSON responses

Fast.Serialization.NullableDateJsonConverter.Format

Source · Targets: net8.0, net9.0, net10.0

public string Format { get; set; }

Date format; defaults to yyyy-MM-dd

Fast.Serialization.NullableDateJsonConverter.NullableDateJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public NullableDateJsonConverter()

Date formatting for nullable DateTime values in JSON responses

Fast.Serialization.NullableDateJsonConverter.NullableDateJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public NullableDateJsonConverter(string format)

Date formatting for nullable DateTime values in JSON responses

• Parameter format: Date/time format

Fast.Serialization.NullableDateJsonConverter.Read

Source · Targets: net8.0, net9.0, net10.0

public override DateTime? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.NullableDateJsonConverter.Write

Source · Targets: net8.0, net9.0, net10.0

public override void Write(Utf8JsonWriter writer, DateTime? value, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.TimeJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public class TimeJsonConverter : JsonConverter<DateTime>

Time formatting for DateTime values in JSON responses

Fast.Serialization.TimeJsonConverter.Format

Source · Targets: net8.0, net9.0, net10.0

public string Format { get; set; }

Time format; defaults to HH:mm:ss

Fast.Serialization.TimeJsonConverter.TimeJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public TimeJsonConverter()

Time formatting for DateTime values in JSON responses

Fast.Serialization.TimeJsonConverter.TimeJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public TimeJsonConverter(string format)

Time formatting for DateTime values in JSON responses

• Parameter format: Date/time format

Fast.Serialization.TimeJsonConverter.Read

Source · Targets: net8.0, net9.0, net10.0

public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.TimeJsonConverter.Write

Source · Targets: net8.0, net9.0, net10.0

public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.NullableTimeJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public class NullableTimeJsonConverter : JsonConverter<DateTime?>

Time formatting for nullable DateTime values in JSON responses

Fast.Serialization.NullableTimeJsonConverter.Format

Source · Targets: net8.0, net9.0, net10.0

public string Format { get; set; }

Time format; defaults to HH:mm:ss

Fast.Serialization.NullableTimeJsonConverter.NullableTimeJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public NullableTimeJsonConverter()

Time formatting for nullable DateTime values in JSON responses

Fast.Serialization.NullableTimeJsonConverter.NullableTimeJsonConverter

Source · Targets: net8.0, net9.0, net10.0

public NullableTimeJsonConverter(string format)

Time formatting for nullable DateTime values in JSON responses

• Parameter format: Date/time format

Fast.Serialization.NullableTimeJsonConverter.Read

Source · Targets: net8.0, net9.0, net10.0

public override DateTime? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.

Fast.Serialization.NullableTimeJsonConverter.Write

Source · Targets: net8.0, net9.0, net10.0

public override void Write(Utf8JsonWriter writer, DateTime? value, JsonSerializerOptions options)

Documentation is inherited from an interface or base class; consult that declaration.