Skip to content

Fast.Serialization.System.Text.Json public API ​

Targets: net8.0;net9.0;net10.0. Select a type in the page outline to find its declaration and members. See the module guide for configuration, examples, and constraints.

Reference version 3.5.21. Source commit a8bd407bf5f6b811da7fb7bd1db827f4da119a94.

Fast.Serialization.JsonContext ​

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

csharp
public static class JsonContext

System.Text.Json serialization context

Fast.Serialization.JsonContext.SerializerOptions ​

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

csharp
public static JsonSerializerOptions SerializerOptions { get; internal set; }

System.Text.Json serialization options

Fast.Serialization.IServiceCollectionExtension ​

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

csharp
public static class IServiceCollectionExtension

Provides System.Text.Json extensions for IServiceCollection

Fast.Serialization.IServiceCollectionExtension.AddSerialization ​

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

csharp
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

csharp
public static class SerializationExtension

Provides System.Text.Json serialization extensions

Fast.Serialization.SerializationExtension.ToObject ​

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

csharp
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

csharp
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

csharp
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

csharp
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

csharp
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

csharp
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

csharp
public enum DataMaskingTypeEnum

Data masking type enum

Fast.Serialization.DataMaskingTypeEnum.Name ​

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

csharp
Name

Name

Fast.Serialization.DataMaskingTypeEnum.NameKeepLast ​

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

csharp
NameKeepLast

Name, preserving the first and last characters

Fast.Serialization.DataMaskingTypeEnum.Account ​

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

csharp
Account

Account

Fast.Serialization.DataMaskingTypeEnum.Mobile ​

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

csharp
Mobile

Mobile number

Fast.Serialization.DataMaskingTypeEnum.IdCard ​

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

csharp
IdCard

Identity card number

Fast.Serialization.DataMaskingTypeEnum.Email ​

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

csharp
Email

Email

Fast.Serialization.DataMaskingTypeEnum.BankCard ​

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

csharp
BankCard

Bank card number

Fast.Serialization.DataMaskingTypeEnum.Address ​

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

csharp
Address

Address

Fast.Serialization.DataMaskingTypeEnum.CarNumber ​

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

csharp
CarNumber

License plate number

Fast.Serialization.DataMaskingTypeEnum.Ip ​

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

csharp
Ip

IP address

Fast.Serialization.DataMaskingConverter ​

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

csharp
public class DataMaskingConverter : JsonConverter<string>

Masks data in JSON responses

Fast.Serialization.DataMaskingConverter.MaskingType ​

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

csharp
public DataMaskingTypeEnum MaskingType { get; set; }

Data masking type

Fast.Serialization.DataMaskingConverter.DataMaskingConverter ​

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

csharp
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

csharp
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

csharp
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

csharp
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

csharp
public string Format { get; set; }

Date format; defaults to yyyy-MM-dd

Fast.Serialization.DateJsonConverter.DateJsonConverter ​

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

csharp
public DateJsonConverter()

Date formatting for DateTime values in JSON responses

Fast.Serialization.DateJsonConverter.DateJsonConverter ​

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

csharp
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

csharp
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

csharp
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

csharp
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

csharp
public string Format { get; set; }

Date format; defaults to yyyy-MM-dd

Fast.Serialization.NullableDateJsonConverter.NullableDateJsonConverter ​

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

csharp
public NullableDateJsonConverter()

Date formatting for nullable DateTime values in JSON responses

Fast.Serialization.NullableDateJsonConverter.NullableDateJsonConverter ​

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

csharp
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

csharp
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

csharp
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

csharp
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

csharp
public string Format { get; set; }

Time format; defaults to HH:mm:ss

Fast.Serialization.TimeJsonConverter.TimeJsonConverter ​

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

csharp
public TimeJsonConverter()

Time formatting for DateTime values in JSON responses

Fast.Serialization.TimeJsonConverter.TimeJsonConverter ​

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

csharp
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

csharp
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

csharp
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

csharp
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

csharp
public string Format { get; set; }

Time format; defaults to HH:mm:ss

Fast.Serialization.NullableTimeJsonConverter.NullableTimeJsonConverter ​

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

csharp
public NullableTimeJsonConverter()

Time formatting for nullable DateTime values in JSON responses

Fast.Serialization.NullableTimeJsonConverter.NullableTimeJsonConverter ​

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

csharp
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

csharp
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

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

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