TomlSerializer Class

Gets a value indicating whether reflection-based serialization is enabled by default.

public static bool IsReflectionEnabledByDefault { get; }

Property value

Remarks

This property is the trimming feature switch: every reflection-based code path is guarded by it, so the trimmer removes them when the switch is disabled.

Methods

Name	Description
Deserialize(Stream, TomlTypeInfo)	Deserializes a TOML payload from a stream using UTF-8 encoding and explicit metadata.
Deserialize(Stream, Type, TomlSerializerContext)	Deserializes a TOML payload from a stream using UTF-8 encoding into an explicit destination type using generated metadata from a serializer context.
Deserialize(Stream, Type, TomlSerializerOptions?)	Deserializes a TOML payload from a stream using UTF-8 encoding into an explicit destination type.
Deserialize(TextReader, TomlTypeInfo)	Deserializes a TOML payload from a text reader using explicit metadata.
Deserialize(TextReader, Type, TomlSerializerContext)	Deserializes a TOML payload from a text reader into an explicit destination type using generated metadata from a serializer context.
Deserialize(TextReader, Type, TomlSerializerOptions?)	Deserializes a TOML payload from a text reader into an explicit destination type.
Deserialize(string, TomlTypeInfo)	Deserializes a TOML payload from text using explicit metadata.
Deserialize(string, Type, TomlSerializerContext)	Deserializes a TOML payload from text into an explicit destination type using generated metadata from a serializer context.
Deserialize(string, Type, TomlSerializerOptions?)	Deserializes a TOML payload from text into an explicit destination type.
Deserialize<T>(Stream, TomlSerializerContext)	Deserializes a TOML payload from a stream using UTF-8 encoding and generated metadata from a serializer context.
Deserialize<T>(Stream, TomlSerializerOptions?)	Deserializes a TOML payload from a stream using UTF-8 encoding.
Deserialize<T>(Stream, TomlTypeInfo<T>)	Deserializes a TOML payload from a stream using UTF-8 encoding and explicit metadata.
Deserialize<T>(TextReader, TomlSerializerContext)	Deserializes a TOML payload from a text reader using generated metadata from a serializer context.
Deserialize<T>(TextReader, TomlSerializerOptions?)	Deserializes a TOML payload from a text reader.
Deserialize<T>(TextReader, TomlTypeInfo<T>)	Deserializes a TOML payload from a text reader using explicit metadata.
Deserialize<T>(string, TomlSerializerContext)	Deserializes a TOML payload from text using generated metadata from a serializer context.
Deserialize<T>(string, TomlSerializerOptions?)	Deserializes a TOML payload from text.
Deserialize<T>(string, TomlTypeInfo<T>)	Deserializes a TOML payload from text using explicit metadata.
DeserializeAsync(Stream, TomlTypeInfo, CancellationToken)	Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding and explicit metadata.
DeserializeAsync(Stream, Type, TomlSerializerContext, CancellationToken)	Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding into an explicit destination type using generated metadata from a serializer context.
DeserializeAsync(Stream, Type, TomlSerializerOptions?, CancellationToken)	Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding into an explicit destination type.
DeserializeAsync<T>(Stream, TomlSerializerContext, CancellationToken)	Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding and generated metadata from a serializer context.
DeserializeAsync<T>(Stream, TomlSerializerOptions?, CancellationToken)	Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding.
DeserializeAsync<T>(Stream, TomlTypeInfo<T>, CancellationToken)	Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding and explicit metadata.
Serialize(Stream, object?, TomlTypeInfo)	Serializes a value to a stream using UTF-8 encoding and explicit metadata.
Serialize(Stream, object?, Type, TomlSerializerContext)	Serializes a value to a stream using UTF-8 encoding, an explicit input type, and generated metadata from a serializer context.
Serialize(Stream, object?, Type, TomlSerializerOptions?)	Serializes a value to a stream using UTF-8 encoding and an explicit input type.
Serialize(TextWriter, object?, TomlTypeInfo)	Serializes a value to a writer using explicit metadata.
Serialize(TextWriter, object?, Type, TomlSerializerContext)	Serializes a value to a writer using an explicit input type and generated metadata from a serializer context.
Serialize(TextWriter, object?, Type, TomlSerializerOptions?)	Serializes a value to a writer using an explicit input type.
Serialize(object?, TomlTypeInfo)	Serializes a value into TOML text using explicit metadata.
Serialize(object?, Type, TomlSerializerContext)	Serializes a value into TOML text using generated metadata from a serializer context.
Serialize(object?, Type, TomlSerializerOptions?)	Serializes a value into TOML text using an explicit input type.
Serialize<T>(Stream, T, TomlSerializerContext)	Serializes a value to a stream using UTF-8 encoding and generated metadata from a serializer context.
Serialize<T>(Stream, T, TomlSerializerOptions?)	Serializes a value to a stream using UTF-8 encoding.
Serialize<T>(Stream, T, TomlTypeInfo<T>)	Serializes a value to a stream using UTF-8 encoding and explicit metadata.
Serialize<T>(TextWriter, T, TomlSerializerContext)	Serializes a value to a writer using generated metadata from a serializer context.
Serialize<T>(TextWriter, T, TomlSerializerOptions?)	Serializes a value to a writer.
Serialize<T>(TextWriter, T, TomlTypeInfo<T>)	Serializes a value to a writer using explicit metadata.
Serialize<T>(T, TomlSerializerContext)	Serializes a value into TOML text using generated metadata from a serializer context.
Serialize<T>(T, TomlSerializerOptions?)	Serializes a value into TOML text.
Serialize<T>(T, TomlTypeInfo<T>)	Serializes a value into TOML text using explicit metadata.
SerializeAsync(Stream, object?, TomlTypeInfo, CancellationToken)	Asynchronously serializes a value to a stream using UTF-8 encoding and explicit metadata.
SerializeAsync(Stream, object?, Type, TomlSerializerContext, CancellationToken)	Asynchronously serializes a value to a stream using UTF-8 encoding, an explicit input type, and generated metadata from a serializer context.
SerializeAsync(Stream, object?, Type, TomlSerializerOptions?, CancellationToken)	Asynchronously serializes a value to a stream using UTF-8 encoding and an explicit input type.
SerializeAsync<T>(Stream, T, TomlSerializerContext, CancellationToken)	Asynchronously serializes a value to a stream using UTF-8 encoding and generated metadata from a serializer context.
SerializeAsync<T>(Stream, T, TomlSerializerOptions?, CancellationToken)	Asynchronously serializes a value to a stream using UTF-8 encoding.
SerializeAsync<T>(Stream, T, TomlTypeInfo<T>, CancellationToken)	Asynchronously serializes a value to a stream using UTF-8 encoding and explicit metadata.
TryDeserialize(Stream, TomlTypeInfo, object?)	Attempts to deserialize a TOML payload from a stream using UTF-8 encoding using explicit metadata.
TryDeserialize(Stream, Type, TomlSerializerContext, object?)	Attempts to deserialize a TOML payload from a stream using UTF-8 encoding into an explicit destination type using generated metadata from a serializer context.
TryDeserialize(Stream, Type, object?, TomlSerializerOptions?)	Attempts to deserialize a TOML payload from a stream using UTF-8 encoding into an explicit destination type.
TryDeserialize(TextReader, TomlTypeInfo, object?)	Attempts to deserialize a TOML payload from a text reader using explicit metadata.
TryDeserialize(TextReader, Type, TomlSerializerContext, object?)	Attempts to deserialize a TOML payload from a text reader into an explicit destination type using generated metadata from a serializer context.
TryDeserialize(TextReader, Type, object?, TomlSerializerOptions?)	Attempts to deserialize a TOML payload from a text reader into an explicit destination type.
TryDeserialize(string, TomlTypeInfo, object?)	Attempts to deserialize a TOML payload from text using explicit metadata.
TryDeserialize(string, Type, TomlSerializerContext, object?)	Attempts to deserialize a TOML payload from text into an explicit destination type using generated metadata from a serializer context.
TryDeserialize(string, Type, object?, TomlSerializerOptions?)	Attempts to deserialize a TOML payload from text into an explicit destination type.
TryDeserialize<T>(Stream, TomlSerializerContext, T?)	Attempts to deserialize a TOML payload from a stream using UTF-8 encoding and generated metadata from a serializer context.
TryDeserialize<T>(Stream, TomlTypeInfo<T>, T?)	Attempts to deserialize a TOML payload from a stream using UTF-8 encoding using explicit metadata.
TryDeserialize<T>(Stream, T?, TomlSerializerOptions?)	Attempts to deserialize a TOML payload from a stream using UTF-8 encoding.
TryDeserialize<T>(TextReader, TomlSerializerContext, T?)	Attempts to deserialize a TOML payload from a text reader using generated metadata from a serializer context.
TryDeserialize<T>(TextReader, TomlTypeInfo<T>, T?)	Attempts to deserialize a TOML payload from a text reader using explicit metadata.
TryDeserialize<T>(TextReader, T?, TomlSerializerOptions?)	Attempts to deserialize a TOML payload from a text reader.
TryDeserialize<T>(string, TomlSerializerContext, T?)	Attempts to deserialize a TOML payload from text using generated metadata from a serializer context.
TryDeserialize<T>(string, TomlTypeInfo<T>, T?)	Attempts to deserialize a TOML payload from text using explicit metadata.
TryDeserialize<T>(string, T?, TomlSerializerOptions?)	Attempts to deserialize a TOML payload from text.

Deserialize overloads

Deserialize(Stream, TomlTypeInfo)

Deserializes a TOML payload from a stream using UTF-8 encoding and explicit metadata.

public static object? Deserialize(Stream stream, TomlTypeInfo typeInfo)

Deserializes a TOML payload from a stream using UTF-8 encoding into an explicit destination type using generated metadata from a serializer context.

public static object? Deserialize(Stream stream, Type returnType, TomlSerializerContext context)

Parameters

stream Stream
returnType Type
context TomlSerializerContext

Returns

Deserialize(Stream, Type, TomlSerializerOptions?)

Deserializes a TOML payload from a stream using UTF-8 encoding into an explicit destination type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static object? Deserialize(Stream stream, Type returnType, TomlSerializerOptions? options = null)

Parameters

stream Stream
returnType Type
options TomlSerializerOptions?

Returns

Deserialize(TextReader, TomlTypeInfo)

Deserializes a TOML payload from a text reader using explicit metadata.

public static object? Deserialize(TextReader reader, TomlTypeInfo typeInfo)

Parameters

reader TextReader
typeInfo TomlTypeInfo

Returns

Deserialize(TextReader, Type, TomlSerializerContext)

Deserializes a TOML payload from a text reader into an explicit destination type using generated metadata from a serializer context.

public static object? Deserialize(TextReader reader, Type returnType, TomlSerializerContext context)

Parameters

reader TextReader
returnType Type
context TomlSerializerContext

Returns

Deserialize(TextReader, Type, TomlSerializerOptions?)

Deserializes a TOML payload from a text reader into an explicit destination type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static object? Deserialize(TextReader reader, Type returnType, TomlSerializerOptions? options = null)

Parameters

reader TextReader
returnType Type
options TomlSerializerOptions?

Returns

Deserialize(string, TomlTypeInfo)

Deserializes a TOML payload from text using explicit metadata.

public static object? Deserialize(string toml, TomlTypeInfo typeInfo)

Parameters

toml string
typeInfo TomlTypeInfo

Returns

Deserialize(string, Type, TomlSerializerContext)

Deserializes a TOML payload from text into an explicit destination type using generated metadata from a serializer context.

public static object? Deserialize(string toml, Type returnType, TomlSerializerContext context)

Parameters

toml string
returnType Type
context TomlSerializerContext

Returns

Deserialize(string, Type, TomlSerializerOptions?)

Deserializes a TOML payload from text into an explicit destination type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static object? Deserialize(string toml, Type returnType, TomlSerializerOptions? options = null)

Parameters

toml string
returnType Type
options TomlSerializerOptions?

Returns

Deserialize<T>(Stream, TomlSerializerContext)

Deserializes a TOML payload from a stream using UTF-8 encoding and generated metadata from a serializer context.

public static T? Deserialize<T>(Stream stream, TomlSerializerContext context)

Type parameters

T

Parameters

stream Stream
context TomlSerializerContext

Returns

T?

Deserialize<T>(Stream, TomlSerializerOptions?)

Deserializes a TOML payload from a stream using UTF-8 encoding.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static T? Deserialize<T>(Stream stream, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

stream Stream
options TomlSerializerOptions?

Returns

T?

Deserialize<T>(Stream, TomlTypeInfo<T>)

Deserializes a TOML payload from a stream using UTF-8 encoding and explicit metadata.

public static T? Deserialize<T>(Stream stream, TomlTypeInfo<T> typeInfo)

Type parameters

T

Parameters

stream Stream
typeInfo TomlTypeInfo<T>

Returns

T?

Deserialize<T>(TextReader, TomlSerializerContext)

Deserializes a TOML payload from a text reader using generated metadata from a serializer context.

public static T? Deserialize<T>(TextReader reader, TomlSerializerContext context)

Type parameters

T

Parameters

reader TextReader
context TomlSerializerContext

Returns

T?

Deserialize<T>(TextReader, TomlSerializerOptions?)

Deserializes a TOML payload from a text reader.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static T? Deserialize<T>(TextReader reader, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

reader TextReader
options TomlSerializerOptions?

Returns

T?

Deserialize<T>(TextReader, TomlTypeInfo<T>)

Deserializes a TOML payload from a text reader using explicit metadata.

public static T? Deserialize<T>(TextReader reader, TomlTypeInfo<T> typeInfo)

Type parameters

T

Parameters

reader TextReader
typeInfo TomlTypeInfo<T>

Returns

T?

Deserialize<T>(string, TomlSerializerContext)

Deserializes a TOML payload from text using generated metadata from a serializer context.

public static T? Deserialize<T>(string toml, TomlSerializerContext context)

Type parameters

T

Parameters

toml string
context TomlSerializerContext

Returns

T?

Deserialize<T>(string, TomlSerializerOptions?)

Deserializes a TOML payload from text.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static T? Deserialize<T>(string toml, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

toml string
options TomlSerializerOptions?

Returns

T?

Deserialize<T>(string, TomlTypeInfo<T>)

Deserializes a TOML payload from text using explicit metadata.

public static T? Deserialize<T>(string toml, TomlTypeInfo<T> typeInfo)

Type parameters

T

Parameters

toml string
typeInfo TomlTypeInfo<T>

Returns

T?

DeserializeAsync overloads

DeserializeAsync(Stream, TomlTypeInfo, CancellationToken)

Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding and explicit metadata.

public static ValueTask<object?> DeserializeAsync(Stream stream, TomlTypeInfo typeInfo, CancellationToken cancellationToken = default)

Parameters

stream Stream
typeInfo TomlTypeInfo
cancellationToken CancellationToken

Returns

ValueTask<object?>

DeserializeAsync(Stream, Type, TomlSerializerContext, CancellationToken)

Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding into an explicit destination type using generated metadata from a serializer context.

public static ValueTask<object?> DeserializeAsync(Stream stream, Type returnType, TomlSerializerContext context, CancellationToken cancellationToken = default)

Parameters

stream Stream
returnType Type
context TomlSerializerContext
cancellationToken CancellationToken

Returns

ValueTask<object?>

DeserializeAsync(Stream, Type, TomlSerializerOptions?, CancellationToken)

Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding into an explicit destination type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static ValueTask<object?> DeserializeAsync(Stream stream, Type returnType, TomlSerializerOptions? options = null, CancellationToken cancellationToken = default)

Parameters

stream Stream
returnType Type
options TomlSerializerOptions?
cancellationToken CancellationToken

Returns

ValueTask<object?>

DeserializeAsync<T>(Stream, TomlSerializerContext, CancellationToken)

Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding and generated metadata from a serializer context.

public static ValueTask<T?> DeserializeAsync<T>(Stream stream, TomlSerializerContext context, CancellationToken cancellationToken = default)

Type parameters

T

Parameters

stream Stream
context TomlSerializerContext
cancellationToken CancellationToken

Returns

ValueTask<T?>

DeserializeAsync<T>(Stream, TomlSerializerOptions?, CancellationToken)

Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static ValueTask<T?> DeserializeAsync<T>(Stream stream, TomlSerializerOptions? options = null, CancellationToken cancellationToken = default)

Type parameters

T

Parameters

stream Stream
options TomlSerializerOptions?
cancellationToken CancellationToken

Returns

ValueTask<T?>

DeserializeAsync<T>(Stream, TomlTypeInfo<T>, CancellationToken)

Asynchronously deserializes a TOML payload from a stream using UTF-8 encoding and explicit metadata.

public static ValueTask<T?> DeserializeAsync<T>(Stream stream, TomlTypeInfo<T> typeInfo, CancellationToken cancellationToken = default)

Type parameters

T

Parameters

stream Stream
typeInfo TomlTypeInfo<T>
cancellationToken CancellationToken

Returns

ValueTask<T?>

Serialize overloads

Serialize(Stream, object?, TomlTypeInfo)

Serializes a value to a stream using UTF-8 encoding and explicit metadata.

public static void Serialize(Stream stream, object? value, TomlTypeInfo typeInfo)

Parameters

stream Stream
value object?
typeInfo TomlTypeInfo

Serialize(Stream, object?, Type, TomlSerializerContext)

Serializes a value to a stream using UTF-8 encoding, an explicit input type, and generated metadata from a serializer context.

public static void Serialize(Stream stream, object? value, Type inputType, TomlSerializerContext context)

Parameters

stream Stream
value object?
inputType Type
context TomlSerializerContext

Serialize(Stream, object?, Type, TomlSerializerOptions?)

Serializes a value to a stream using UTF-8 encoding and an explicit input type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static void Serialize(Stream stream, object? value, Type inputType, TomlSerializerOptions? options = null)

Parameters

stream Stream
value object?
inputType Type
options TomlSerializerOptions?

Serialize(TextWriter, object?, TomlTypeInfo)

Serializes a value to a writer using explicit metadata.

public static void Serialize(TextWriter writer, object? value, TomlTypeInfo typeInfo)

Parameters

writer TextWriter
value object?
typeInfo TomlTypeInfo

Serialize(TextWriter, object?, Type, TomlSerializerContext)

Serializes a value to a writer using an explicit input type and generated metadata from a serializer context.

public static void Serialize(TextWriter writer, object? value, Type inputType, TomlSerializerContext context)

Parameters

writer TextWriter
value object?
inputType Type
context TomlSerializerContext

Serialize(TextWriter, object?, Type, TomlSerializerOptions?)

Serializes a value to a writer using an explicit input type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static void Serialize(TextWriter writer, object? value, Type inputType, TomlSerializerOptions? options = null)

Parameters

writer TextWriter
value object?
inputType Type
options TomlSerializerOptions?

Serialize(object?, TomlTypeInfo)

Serializes a value into TOML text using explicit metadata.

public static string Serialize(object? value, TomlTypeInfo typeInfo)

Parameters

value object?
typeInfo TomlTypeInfo

Returns

Serialize(object?, Type, TomlSerializerContext)

Serializes a value into TOML text using generated metadata from a serializer context.

public static string Serialize(object? value, Type inputType, TomlSerializerContext context)

Parameters

value object?
inputType Type
context TomlSerializerContext

Returns

Serialize(object?, Type, TomlSerializerOptions?)

Serializes a value into TOML text using an explicit input type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static string Serialize(object? value, Type inputType, TomlSerializerOptions? options = null)

Parameters

value object?
inputType Type
options TomlSerializerOptions?

Returns

Serialize<T>(Stream, T, TomlSerializerContext)

Serializes a value to a stream using UTF-8 encoding and generated metadata from a serializer context.

public static void Serialize<T>(Stream stream, T value, TomlSerializerContext context)

Type parameters

T

Parameters

stream Stream
value T
context TomlSerializerContext

Serialize<T>(Stream, T, TomlSerializerOptions?)

Serializes a value to a stream using UTF-8 encoding.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static void Serialize<T>(Stream stream, T value, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

stream Stream
value T
options TomlSerializerOptions?

Serialize<T>(Stream, T, TomlTypeInfo<T>)

Serializes a value to a stream using UTF-8 encoding and explicit metadata.

public static void Serialize<T>(Stream stream, T value, TomlTypeInfo<T> typeInfo)

Type parameters

T

Parameters

stream Stream
value T
typeInfo TomlTypeInfo<T>

Serialize<T>(TextWriter, T, TomlSerializerContext)

Serializes a value to a writer using generated metadata from a serializer context.

public static void Serialize<T>(TextWriter writer, T value, TomlSerializerContext context)

Type parameters

T

Parameters

writer TextWriter
value T
context TomlSerializerContext

Serialize<T>(TextWriter, T, TomlSerializerOptions?)

Serializes a value to a writer.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static void Serialize<T>(TextWriter writer, T value, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

writer TextWriter
value T
options TomlSerializerOptions?

Serialize<T>(TextWriter, T, TomlTypeInfo<T>)

Serializes a value to a writer using explicit metadata.

public static void Serialize<T>(TextWriter writer, T value, TomlTypeInfo<T> typeInfo)

Type parameters

T

Parameters

writer TextWriter
value T
typeInfo TomlTypeInfo<T>

Serialize<T>(T, TomlSerializerContext)

Serializes a value into TOML text using generated metadata from a serializer context.

public static string Serialize<T>(T value, TomlSerializerContext context)

Type parameters

T

Parameters

value T
context TomlSerializerContext

Returns

Serialize<T>(T, TomlSerializerOptions?)

Serializes a value into TOML text.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static string Serialize<T>(T value, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

value T
options TomlSerializerOptions?

Returns

Serialize<T>(T, TomlTypeInfo<T>)

Serializes a value into TOML text using explicit metadata.

public static string Serialize<T>(T value, TomlTypeInfo<T> typeInfo)

Type parameters

T

Parameters

value T
typeInfo TomlTypeInfo<T>

Returns

SerializeAsync overloads

SerializeAsync(Stream, object?, TomlTypeInfo, CancellationToken)

Asynchronously serializes a value to a stream using UTF-8 encoding and explicit metadata.

public static Task SerializeAsync(Stream stream, object? value, TomlTypeInfo typeInfo, CancellationToken cancellationToken = default)

Parameters

stream Stream
value object?
typeInfo TomlTypeInfo
cancellationToken CancellationToken

Returns

SerializeAsync(Stream, object?, Type, TomlSerializerContext, CancellationToken)

Asynchronously serializes a value to a stream using UTF-8 encoding, an explicit input type, and generated metadata from a serializer context.

public static Task SerializeAsync(Stream stream, object? value, Type inputType, TomlSerializerContext context, CancellationToken cancellationToken = default)

Parameters

stream Stream
value object?
inputType Type
context TomlSerializerContext
cancellationToken CancellationToken

Returns

SerializeAsync(Stream, object?, Type, TomlSerializerOptions?, CancellationToken)

Asynchronously serializes a value to a stream using UTF-8 encoding and an explicit input type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static Task SerializeAsync(Stream stream, object? value, Type inputType, TomlSerializerOptions? options = null, CancellationToken cancellationToken = default)

Parameters

stream Stream
value object?
inputType Type
options TomlSerializerOptions?
cancellationToken CancellationToken

Returns

SerializeAsync<T>(Stream, T, TomlSerializerContext, CancellationToken)

Asynchronously serializes a value to a stream using UTF-8 encoding and generated metadata from a serializer context.

public static Task SerializeAsync<T>(Stream stream, T value, TomlSerializerContext context, CancellationToken cancellationToken = default)

Type parameters

T

Parameters

stream Stream
value T
context TomlSerializerContext
cancellationToken CancellationToken

Returns

SerializeAsync<T>(Stream, T, TomlSerializerOptions?, CancellationToken)

Asynchronously serializes a value to a stream using UTF-8 encoding.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static Task SerializeAsync<T>(Stream stream, T value, TomlSerializerOptions? options = null, CancellationToken cancellationToken = default)

Type parameters

T

Parameters

stream Stream
value T
options TomlSerializerOptions?
cancellationToken CancellationToken

Returns

SerializeAsync<T>(Stream, T, TomlTypeInfo<T>, CancellationToken)

Asynchronously serializes a value to a stream using UTF-8 encoding and explicit metadata.

public static Task SerializeAsync<T>(Stream stream, T value, TomlTypeInfo<T> typeInfo, CancellationToken cancellationToken = default)

Type parameters

T

Parameters

stream Stream
value T
typeInfo TomlTypeInfo<T>
cancellationToken CancellationToken

Returns

TryDeserialize overloads

TryDeserialize(Stream, TomlTypeInfo, object?)

Attempts to deserialize a TOML payload from a stream using UTF-8 encoding using explicit metadata.

public static bool TryDeserialize(Stream stream, TomlTypeInfo typeInfo, out object? value)

Parameters

stream Stream
typeInfo TomlTypeInfo
value object?

Returns

TryDeserialize(Stream, Type, TomlSerializerContext, object?)

Attempts to deserialize a TOML payload from a stream using UTF-8 encoding into an explicit destination type using generated metadata from a serializer context.

public static bool TryDeserialize(Stream stream, Type returnType, TomlSerializerContext context, out object? value)

Parameters

stream Stream
returnType Type
context TomlSerializerContext
value object?

Returns

TryDeserialize(Stream, Type, object?, TomlSerializerOptions?)

Attempts to deserialize a TOML payload from a stream using UTF-8 encoding into an explicit destination type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static bool TryDeserialize(Stream stream, Type returnType, out object? value, TomlSerializerOptions? options = null)

Parameters

stream Stream
returnType Type
value object?
options TomlSerializerOptions?

Returns

TryDeserialize(TextReader, TomlTypeInfo, object?)

Attempts to deserialize a TOML payload from a text reader using explicit metadata.

public static bool TryDeserialize(TextReader reader, TomlTypeInfo typeInfo, out object? value)

Parameters

reader TextReader
typeInfo TomlTypeInfo
value object?

Returns

TryDeserialize(TextReader, Type, TomlSerializerContext, object?)

Attempts to deserialize a TOML payload from a text reader into an explicit destination type using generated metadata from a serializer context.

public static bool TryDeserialize(TextReader reader, Type returnType, TomlSerializerContext context, out object? value)

Parameters

reader TextReader
returnType Type
context TomlSerializerContext
value object?

Returns

TryDeserialize(TextReader, Type, object?, TomlSerializerOptions?)

Attempts to deserialize a TOML payload from a text reader into an explicit destination type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static bool TryDeserialize(TextReader reader, Type returnType, out object? value, TomlSerializerOptions? options = null)

Parameters

reader TextReader
returnType Type
value object?
options TomlSerializerOptions?

Returns

TryDeserialize(string, TomlTypeInfo, object?)

Attempts to deserialize a TOML payload from text using explicit metadata.

public static bool TryDeserialize(string toml, TomlTypeInfo typeInfo, out object? value)

Parameters

toml string
typeInfo TomlTypeInfo
value object?

Returns

TryDeserialize(string, Type, TomlSerializerContext, object?)

Attempts to deserialize a TOML payload from text into an explicit destination type using generated metadata from a serializer context.

public static bool TryDeserialize(string toml, Type returnType, TomlSerializerContext context, out object? value)

Parameters

toml string
returnType Type
context TomlSerializerContext
value object?

Returns

TryDeserialize(string, Type, object?, TomlSerializerOptions?)

Attempts to deserialize a TOML payload from text into an explicit destination type.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static bool TryDeserialize(string toml, Type returnType, out object? value, TomlSerializerOptions? options = null)

Parameters

toml string
returnType Type
value object?
options TomlSerializerOptions?

Returns

TryDeserialize<T>(Stream, TomlSerializerContext, T?)

Attempts to deserialize a TOML payload from a stream using UTF-8 encoding and generated metadata from a serializer context.

public static bool TryDeserialize<T>(Stream stream, TomlSerializerContext context, out T? value)

Type parameters

T

Parameters

stream Stream
context TomlSerializerContext
value T?

Returns

TryDeserialize<T>(Stream, TomlTypeInfo<T>, T?)

Attempts to deserialize a TOML payload from a stream using UTF-8 encoding using explicit metadata.

public static bool TryDeserialize<T>(Stream stream, TomlTypeInfo<T> typeInfo, out T? value)

Type parameters

T

Parameters

stream Stream
typeInfo TomlTypeInfo<T>
value T?

Returns

TryDeserialize<T>(Stream, T?, TomlSerializerOptions?)

Attempts to deserialize a TOML payload from a stream using UTF-8 encoding.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static bool TryDeserialize<T>(Stream stream, out T? value, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

stream Stream
value T?
options TomlSerializerOptions?

Returns

TryDeserialize<T>(TextReader, TomlSerializerContext, T?)

Attempts to deserialize a TOML payload from a text reader using generated metadata from a serializer context.

public static bool TryDeserialize<T>(TextReader reader, TomlSerializerContext context, out T? value)

Type parameters

T

Parameters

reader TextReader
context TomlSerializerContext
value T?

Returns

TryDeserialize<T>(TextReader, TomlTypeInfo<T>, T?)

Attempts to deserialize a TOML payload from a text reader using explicit metadata.

public static bool TryDeserialize<T>(TextReader reader, TomlTypeInfo<T> typeInfo, out T? value)

Type parameters

T

Parameters

reader TextReader
typeInfo TomlTypeInfo<T>
value T?

Returns

TryDeserialize<T>(TextReader, T?, TomlSerializerOptions?)

Attempts to deserialize a TOML payload from a text reader.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static bool TryDeserialize<T>(TextReader reader, out T? value, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

reader TextReader
value T?
options TomlSerializerOptions?

Returns

TryDeserialize<T>(string, TomlSerializerContext, T?)

Attempts to deserialize a TOML payload from text using generated metadata from a serializer context.

public static bool TryDeserialize<T>(string toml, TomlSerializerContext context, out T? value)

Type parameters

T

Parameters

toml string
context TomlSerializerContext
value T?

Returns

TryDeserialize<T>(string, TomlTypeInfo<T>, T?)

Attempts to deserialize a TOML payload from text using explicit metadata.

public static bool TryDeserialize<T>(string toml, TomlTypeInfo<T> typeInfo, out T? value)

Type parameters

T

Parameters

toml string
typeInfo TomlTypeInfo<T>
value T?

Returns

TryDeserialize<T>(string, T?, TomlSerializerOptions?)

Attempts to deserialize a TOML payload from text.

[RequiresDynamicCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
[RequiresUnreferencedCode("Reflection-based TOML serialization is not compatible with trimming/NativeAOT. Use a source-generated TomlSerializerContext or pass a TomlTypeInfo instance.")]
public static bool TryDeserialize<T>(string toml, out T? value, TomlSerializerOptions? options = null)

Type parameters

T

Parameters

toml string
value T?
options TomlSerializerOptions?

Returns