https://github.com/open-net-libraries/open.serialization
DI/IoC agnostic interfaces for injecting any serialization library.
https://github.com/open-net-libraries/open.serialization
dependency-injection di dotnet dotnet-core dotnet-standard dotnetcore dotnetstandard ioc json newtonsoft serialization system-text-json utf8json
Last synced: 3 days ago
JSON representation
DI/IoC agnostic interfaces for injecting any serialization library.
- Host: GitHub
- URL: https://github.com/open-net-libraries/open.serialization
- Owner: Open-NET-Libraries
- License: mit
- Created: 2019-10-27T15:02:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T02:13:36.000Z (12 months ago)
- Last Synced: 2025-04-02T11:04:32.824Z (6 months ago)
- Topics: dependency-injection, di, dotnet, dotnet-core, dotnet-standard, dotnetcore, dotnetstandard, ioc, json, newtonsoft, serialization, system-text-json, utf8json
- Language: C#
- Size: 242 KB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open.Serialization
DI/IoC agnostic interfaces for injecting any serialization library.
## Implementation
With the following libraries, you can build other libraries that sever their dependency from any serializer and allow you to inject whichever you want. You can also easily integrate another serializer and still retain the DI/IoC happiness.
### Core Interfaces & Extensions
[https://www.nuget.org/packages/Open.Serialization](https://www.nuget.org/packages/Open.Serialization/)
[](https://www.nuget.org/packages/Open.Serialization/) Core package for serializing anything.
[https://www.nuget.org/packages/Open.Serialization.Json](https://www.nuget.org/packages/Open.Serialization.Json/)
[](https://www.nuget.org/packages/Open.Serialization.Json/) Core package specific to JSON.
### Library/Vendor Specific Implementations
```cs
services.AddJsonSerializer();
```
The following libs contain support for `Microsoft.Extensions.DependencyInjection`.
Import any of these and you can use the above extension to inject default serializers.
[https://www.nuget.org/packages/Open.Serialization.Json.Newtonsoft](https://www.nuget.org/packages/Open.Serialization.Json.Newtonsoft/)
[](https://www.nuget.org/packages/Open.Serialization.Json.Newtonsoft/) Extensions and DI for **Newtonsoft.Json**.
[https://www.nuget.org/packages/Open.Serialization.Json.System](https://www.nuget.org/packages/Open.Serialization.Json.System/)
[](https://www.nuget.org/packages/Open.Serialization.Json.System/) Extensions and DI for **System.Text.Json**. *Note: There is no `IJsonObjectSerializer` option for `System.Text.Json`.*
[https://www.nuget.org/packages/Open.Serialization.Json.Utf8Json](https://www.nuget.org/packages/Open.Serialization.Json.Utf8Json/)
[](https://www.nuget.org/packages/Open.Serialization.Json.Utf8Json/) Extensions and DI for **Utf8Json**.
## Interface & Methods Exposed
```cs
T IDeserialize.Deserialize(string value);
T IDeserialize.Deserialize(string value);
object IDeserializeObject.Deserialize(string value, Type type);
ValueTask IDeserializeAsync.DeserializeAsync(Stream source, CancellationToken cancellationToken = default);
ValueTask IDeserializeAsync.DeserializeAsync(Stream source, CancellationToken cancellationToken = default);
ValueTask IDeserializeObjectAsync.DeserializeAsync(Stream source, Type type, CancellationToken cancellationToken = default);
string ISerialize.Serialize(T item);
string ISerialize.Serialize(T item);
string ISerializeObject.Serialize(object item, Type type);
ValueTask ISerializeAsync.SerializeAsync(Stream target, T item, CancellationToken cancellationToken = default);
ValueTask ISerializeAsync.SerializeAsync(Stream target, T item, CancellationToken cancellationToken = default);
ValueTask ISerializeObjectAsync.SerializeAsync(Stream target, object item, Type type, CancellationToken cancellationToken = default);
```