Serializer.Serialize Method

Definition

Namespace:: Orleans.Serialization

Assembly:: Orleans.Serialization.dll

Package:: Microsoft.Orleans.Serialization v10.0.0

Package:: Microsoft.Orleans.Serialization v7.2.5

Package:: Microsoft.Orleans.Serialization v8.0.0

Package:: Microsoft.Orleans.Serialization v8.1.0

Package:: Microsoft.Orleans.Serialization v8.2.0

Package:: Microsoft.Orleans.Serialization v9.0.0

Package:: Microsoft.Orleans.Serialization v9.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
Serialize<T,TBufferWriter>(T, TBufferWriter, SerializerSession)	Serializes the provided `value` into `destination`.
Serialize<T,TBufferWriter>(T, TBufferWriter)	Serializes the provided `value` into `destination`.
Serialize<T,TBufferWriter>(T, Writer<TBufferWriter>)	Serializes the provided `value` into `destination`.
Serialize<T>(T, Stream, SerializerSession, Int32)	Serializes the provided `value` into `destination`.
Serialize<T>(T, Span<Byte>, SerializerSession)	Serializes the provided `value` into `destination`.
Serialize<T>(T, Memory<Byte>, SerializerSession)	Serializes the provided `value` into `destination`.
Serialize<T>(T, Span<Byte>)	Serializes the provided `value` into `destination`.
Serialize<T>(T, Byte[], SerializerSession)	Serializes the provided `value` into `destination`.
Serialize<T>(T, ArraySegment<Byte>, SerializerSession)	Serializes the provided `value` into `destination`.
Serialize<T>(T, Memory<Byte>)	Serializes the provided `value` into `destination`.
Serialize<T>(T, Byte[])	Serializes the provided `value` into `destination`.
Serialize<T>(T, ArraySegment<Byte>)	Serializes the provided `value` into `destination`.
Serialize<T>(T, Stream, Int32)	Serializes the provided `value` into `destination`.

Serialize<T,TBufferWriter>(T, TBufferWriter, SerializerSession)

Serializes the provided value into destination.

public void Serialize<T,TBufferWriter>(T value, TBufferWriter destination, Orleans.Serialization.Session.SerializerSession session) where TBufferWriter : System.Buffers.IBufferWriter<byte>;

member this.Serialize : 'T * 'BufferWriter * Orleans.Serialization.Session.SerializerSession -> unit (requires 'BufferWriter :> System.Buffers.IBufferWriter<byte>)

Public Sub Serialize(Of T, TBufferWriter) (value As T, destination As TBufferWriter, session As SerializerSession)

Type Parameters

T

The expected type of value.

TBufferWriter

The output buffer writer.

Parameters

value: T

The value to serialize.

destination: TBufferWriter

The destination where serialized data will be written.

session: SerializerSession

The serializer session.

Applies to

Serialize<T,TBufferWriter>(T, TBufferWriter)

Serializes the provided value into destination.

public void Serialize<T,TBufferWriter>(T value, TBufferWriter destination) where TBufferWriter : System.Buffers.IBufferWriter<byte>;

member this.Serialize : 'T * 'BufferWriter -> unit (requires 'BufferWriter :> System.Buffers.IBufferWriter<byte>)

Public Sub Serialize(Of T, TBufferWriter) (value As T, destination As TBufferWriter)

Type Parameters

T

The expected type of value.

TBufferWriter

The output buffer writer.

Parameters

value: T

The value to serialize.

destination: TBufferWriter

The destination where serialized data will be written.

Applies to

Serialize<T,TBufferWriter>(T, Writer<TBufferWriter>)

Serializes the provided value into destination.

public void Serialize<T,TBufferWriter>(T value, ref Orleans.Serialization.Buffers.Writer<TBufferWriter> destination) where TBufferWriter : System.Buffers.IBufferWriter<byte>;

member this.Serialize : 'T * Writer -> unit (requires 'BufferWriter :> System.Buffers.IBufferWriter<byte>)

Public Sub Serialize(Of T, TBufferWriter) (value As T, ByRef destination As Writer(Of TBufferWriter))

Type Parameters

T

The expected type of value.

TBufferWriter

The output buffer writer.

Parameters

value: T

The value to serialize.

destination: Writer<TBufferWriter>

The destination where serialized data will be written.

Applies to

Serialize<T>(T, Stream, SerializerSession, Int32)

Serializes the provided value into destination.

public void Serialize<T>(T value, System.IO.Stream destination, Orleans.Serialization.Session.SerializerSession session, int sizeHint = 0);

member this.Serialize : 'T * System.IO.Stream * Orleans.Serialization.Session.SerializerSession * int -> unit

Public Sub Serialize(Of T) (value As T, destination As Stream, session As SerializerSession, Optional sizeHint As Integer = 0)

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: Stream

The destination where serialized data will be written.

session: SerializerSession

The serializer session.

sizeHint: Int32

The estimated upper bound for the length of the serialized data.

Remarks

The destination stream will not be flushed by this method.

Applies to

Serialize<T>(T, Span<Byte>, SerializerSession)

Serializes the provided value into destination.

public void Serialize<T>(T value, ref Span<byte> destination, Orleans.Serialization.Session.SerializerSession session);

member this.Serialize : 'T * Span * Orleans.Serialization.Session.SerializerSession -> unit

Public Sub Serialize(Of T) (value As T, ByRef destination As Span(Of Byte), session As SerializerSession)

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: Span<Byte>

The destination where serialized data will be written.

session: SerializerSession

The serializer session.

Remarks

This method slices the destination to the serialized data length.

Applies to

Serialize<T>(T, Memory<Byte>, SerializerSession)

Serializes the provided value into destination.

public void Serialize<T>(T value, ref Memory<byte> destination, Orleans.Serialization.Session.SerializerSession session);

member this.Serialize : 'T * Memory * Orleans.Serialization.Session.SerializerSession -> unit

Public Sub Serialize(Of T) (value As T, ByRef destination As Memory(Of Byte), session As SerializerSession)

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: Memory<Byte>

The destination where serialized data will be written.

session: SerializerSession

The serializer session.

Remarks

This method slices the destination to the serialized data length.

Applies to

Serialize<T>(T, Span<Byte>)

Serializes the provided value into destination.

public void Serialize<T>(T value, ref Span<byte> destination);

member this.Serialize : 'T * Span -> unit

Public Sub Serialize(Of T) (value As T, ByRef destination As Span(Of Byte))

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: Span<Byte>

The destination where serialized data will be written.

Remarks

This method slices the destination to the serialized data length.

Applies to

Serialize<T>(T, Byte[], SerializerSession)

Serializes the provided value into destination.

public int Serialize<T>(T value, byte[] destination, Orleans.Serialization.Session.SerializerSession session);

member this.Serialize : 'T * byte[] * Orleans.Serialization.Session.SerializerSession -> int

Public Function Serialize(Of T) (value As T, destination As Byte(), session As SerializerSession) As Integer

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: Byte[]

The destination where serialized data will be written.

session: SerializerSession

The serializer session.

Returns

Int32

The length of the serialized data.

Applies to

Serialize<T>(T, ArraySegment<Byte>, SerializerSession)

Serializes the provided value into destination.

public int Serialize<T>(T value, ArraySegment<byte> destination, Orleans.Serialization.Session.SerializerSession session);

member this.Serialize : 'T * ArraySegment<byte> * Orleans.Serialization.Session.SerializerSession -> int

Public Function Serialize(Of T) (value As T, destination As ArraySegment(Of Byte), session As SerializerSession) As Integer

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: ArraySegment<Byte>

The destination where serialized data will be written.

session: SerializerSession

The serializer session.

Returns

Int32

The length of the serialized data.

Applies to

Serialize<T>(T, Memory<Byte>)

Serializes the provided value into destination.

public void Serialize<T>(T value, ref Memory<byte> destination);

member this.Serialize : 'T * Memory -> unit

Public Sub Serialize(Of T) (value As T, ByRef destination As Memory(Of Byte))

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: Memory<Byte>

The destination where serialized data will be written.

Remarks

This method slices the destination to the serialized data length.

Applies to

Serialize<T>(T, Byte[])

Serializes the provided value into destination.

public int Serialize<T>(T value, byte[] destination);

member this.Serialize : 'T * byte[] -> int

Public Function Serialize(Of T) (value As T, destination As Byte()) As Integer

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: Byte[]

The destination where serialized data will be written.

Returns

Int32

The length of the serialized data.

Applies to

Serialize<T>(T, ArraySegment<Byte>)

Serializes the provided value into destination.

public int Serialize<T>(T value, ArraySegment<byte> destination);

member this.Serialize : 'T * ArraySegment<byte> -> int

Public Function Serialize(Of T) (value As T, destination As ArraySegment(Of Byte)) As Integer

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: ArraySegment<Byte>

The destination where serialized data will be written.

Returns

Int32

The length of the serialized data.

Applies to

Serialize<T>(T, Stream, Int32)

Serializes the provided value into destination.

public void Serialize<T>(T value, System.IO.Stream destination, int sizeHint = 0);

member this.Serialize : 'T * System.IO.Stream * int -> unit

Public Sub Serialize(Of T) (value As T, destination As Stream, Optional sizeHint As Integer = 0)

Type Parameters

T

The expected type of value.

Parameters

value: T

The value to serialize.

destination: Stream

The destination where serialized data will be written.

sizeHint: Int32

The estimated upper bound for the length of the serialized data.

Remarks

The destination stream will not be flushed by this method.

Applies to