AvroSharp.Codecs
0.1.1
dotnet add package AvroSharp.Codecs --version 0.1.1
NuGet\Install-Package AvroSharp.Codecs -Version 0.1.1
<PackageReference Include="AvroSharp.Codecs" Version="0.1.1" />
<PackageVersion Include="AvroSharp.Codecs" Version="0.1.1" />
<PackageReference Include="AvroSharp.Codecs" />
paket add AvroSharp.Codecs --version 0.1.1
#r "nuget: AvroSharp.Codecs, 0.1.1"
#:package AvroSharp.Codecs@0.1.1
#addin nuget:?package=AvroSharp.Codecs&version=0.1.1
#tool nuget:?package=AvroSharp.Codecs&version=0.1.1
AvroSharp.Codecs
The snappy, zstandard, bzip2 and xz codecs for AvroSharp's object container files. With the null and deflate codecs built into AvroSharp, that covers every codec in the Avro specification. All of them use fully managed libraries, with no native binaries or P/Invoke.
Status: early development, not yet released.
Reading
A file's codec is not known until it is opened, so give the reader all of them:
using AvroSharp.Codecs;
using AvroSharp.Containers;
using var reader = AvroFileReader.OpenGeneric(stream, options: new AvroFileReaderOptions { Codecs = AvroCodecs.All });
Writing
| Codec | Class | Settings (defaults as in Apache Avro Java) | Library |
|---|---|---|---|
snappy |
SnappyCodec.Default |
none; each block ends with a CRC-32 of its data, checked on read | Snappier (BSD-3-Clause) |
zstandard |
ZstandardCodec |
level (default 3), checksum (default off) |
ZstdSharp.Port (MIT) |
bzip2 |
Bzip2Codec |
blockSize 1-9 (default 9) |
SharpZipLib (MIT) |
xz |
XzCodec |
level 0-9 (default 6) |
Lzma.Net (0BSD) |
var options = new AvroFileWriterOptions { Codec = new ZstandardCodec(level: 9, checksum: true) };
using var writer = AvroFileWriter.CreateGeneric(stream, schema, options);
Zstandard frames without a checksum (Java's default) have no integrity check, so a damaged block may decompress to other bytes. The other codecs detect damaged blocks, and the reader reports them as AvroDataException.
The codecs are tested against files written by Apache Avro Java 1.12.2 in every codec, Java reads the files they write, and snappy and bzip2 are also checked against Apache.Avro C#'s codec packages in both directions.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. 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. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- AvroSharp (>= 0.1.1)
- Lzma.Net (>= 5.8.4.3)
- Microsoft.Bcl.AsyncInterfaces (>= 10.0.12)
- SharpZipLib (>= 1.4.2)
- Snappier (>= 1.3.1)
- System.IO.Hashing (>= 10.0.12)
- System.Memory (>= 4.6.3)
- System.Text.Json (>= 10.0.12)
- System.Threading.Channels (>= 10.0.12)
- ZstdSharp.Port (>= 0.8.8)
-
.NETStandard 2.1
- AvroSharp (>= 0.1.1)
- Lzma.Net (>= 5.8.4.3)
- Microsoft.Bcl.AsyncInterfaces (>= 10.0.12)
- SharpZipLib (>= 1.4.2)
- Snappier (>= 1.3.1)
- System.IO.Hashing (>= 10.0.12)
- System.Text.Json (>= 10.0.12)
- System.Threading.Channels (>= 10.0.12)
- ZstdSharp.Port (>= 0.8.8)
-
net10.0
- AvroSharp (>= 0.1.1)
- Lzma.Net (>= 5.8.4.3)
- SharpZipLib (>= 1.4.2)
- Snappier (>= 1.3.1)
- System.IO.Hashing (>= 10.0.12)
- ZstdSharp.Port (>= 0.8.8)
-
net8.0
- AvroSharp (>= 0.1.1)
- Lzma.Net (>= 5.8.4.3)
- SharpZipLib (>= 1.4.2)
- Snappier (>= 1.3.1)
- System.IO.Hashing (>= 10.0.12)
- ZstdSharp.Port (>= 0.8.8)
-
net9.0
- AvroSharp (>= 0.1.1)
- Lzma.Net (>= 5.8.4.3)
- SharpZipLib (>= 1.4.2)
- Snappier (>= 1.3.1)
- System.IO.Hashing (>= 10.0.12)
- ZstdSharp.Port (>= 0.8.8)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.