Soenneker.Cosmos.Serializer 4.0.2734

Prefix Reserved
dotnet add package Soenneker.Cosmos.Serializer --version 4.0.2734
                    
NuGet\Install-Package Soenneker.Cosmos.Serializer -Version 4.0.2734
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Soenneker.Cosmos.Serializer" Version="4.0.2734" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Soenneker.Cosmos.Serializer" Version="4.0.2734" />
                    
Directory.Packages.props
<PackageReference Include="Soenneker.Cosmos.Serializer" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Soenneker.Cosmos.Serializer --version 4.0.2734
                    
#r "nuget: Soenneker.Cosmos.Serializer, 4.0.2734"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Soenneker.Cosmos.Serializer@4.0.2734
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Soenneker.Cosmos.Serializer&version=4.0.2734
                    
Install as a Cake Addin
#tool nuget:?package=Soenneker.Cosmos.Serializer&version=4.0.2734
                    
Install as a Cake Tool

alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image

Soenneker.Cosmos.Serializer

An Azure Cosmos DB CosmosSerializer backed by System.Text.Json and pooled memory streams.

Installation

dotnet add package Soenneker.Cosmos.Serializer

Use with CosmosClient

using Soenneker.Cosmos.Serializer;
using Soenneker.Utils.MemoryStream.Abstract;
using Soenneker.Utils.MemoryStream.Registrars;

services.AddMemoryStreamUtilAsSingleton();

IMemoryStreamUtil memoryStreams =
    serviceProvider.GetRequiredService<IMemoryStreamUtil>();

var serializer = new CosmosSystemTextJsonSerializer(memoryStreams);

var client = new CosmosClient(
    endpoint,
    accountKey,
    new CosmosClientOptions
    {
        Serializer = serializer
    });

Soenneker.Cosmos.Client already constructs and installs this serializer, so applications using that client utility do not need to configure it again.

JSON behavior

Serialization uses Soenneker.Json.OptionsCollection.JsonOptionsCollection.WebOptions. The same options are used for reads and writes, keeping property naming and configured converters consistent. This replaces the Cosmos SDK's default Newtonsoft.Json serializer, so verify stored JSON compatibility before switching an existing container.

Stream ownership

ToStream returns a positioned stream owned by the Cosmos SDK or direct caller. The recipient must dispose it. If serialization fails before the stream is returned, the serializer disposes the pooled stream itself.

FromStream<T> consumes and disposes the supplied stream after deserialization. The exception is FromStream<Stream>, which returns the original stream without disposing it and transfers ownership to the caller. An empty MemoryStream deserializes to default(T).

Serialization and deserialization failures propagate to the caller. The adapter uses the synchronous CosmosSerializer contract, so it does not accept a cancellation token.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Soenneker.Cosmos.Serializer:

Package Downloads
Soenneker.Cosmos.Client

A utility library for Azure Cosmos client accessibility

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.0.2734 0 9/16/2026
4.0.2733 0 9/16/2026
4.0.2732 10 9/15/2026
4.0.2731 48 9/15/2026
4.0.2730 270 9/13/2026
4.0.2729 77 9/13/2026
4.0.2728 59 9/13/2026
4.0.2727 88 9/13/2026
4.0.2726 282 9/13/2026
4.0.2725 56 9/13/2026
4.0.2724 203 9/12/2026
4.0.2722 202 9/12/2026
4.0.2721 71 9/12/2026
4.0.2720 63 9/12/2026
4.0.2719 65 9/12/2026
4.0.2718 996 9/9/2026
4.0.2717 96 9/9/2026
4.0.2716 292 9/8/2026
4.0.2715 729 9/8/2026
4.0.2714 165 9/8/2026
Loading failed

Update dependency Soenneker.Utils.MemoryStream to 4.0.1556 (#3549)