Class CosmosSerializer

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

This abstract class can be implemented to allow a custom serializer to be used by the CosmosClient.

public abstract class CosmosSerializer

Inheritance

object

CosmosSerializer

Derived

CosmosLinqSerializer

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Constructors

CosmosSerializer()

protected CosmosSerializer()

Methods

FromStream<T>(Stream)

Convert a Stream of JSON to an object. The implementation is responsible for Disposing of the stream, including when an exception is thrown, to avoid memory leaks.

public abstract T FromStream<T>(Stream stream)

Parameters

stream Stream

The Stream response containing JSON from Cosmos DB.

Returns

T

The object deserialized from the stream.

Type Parameters

T

Any type passed to Container.

ToStream<T>(T)

Convert the object to a Stream. The caller will take ownership of the stream and ensure it is correctly disposed of. Stream.CanRead must be true.

public abstract Stream ToStream<T>(T input)

Parameters

input T

Any type passed to Container.

Returns

Stream

A readable Stream containing JSON of the serialized object.

Type Parameters

T