System.Formats.Cbor 8.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package System.Formats.Cbor --version 8.0.0
NuGet\Install-Package System.Formats.Cbor -Version 8.0.0
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="System.Formats.Cbor" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add System.Formats.Cbor --version 8.0.0
#r "nuget: System.Formats.Cbor, 8.0.0"
#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.
// Install System.Formats.Cbor as a Cake Addin
#addin nuget:?package=System.Formats.Cbor&version=8.0.0

// Install System.Formats.Cbor as a Cake Tool
#tool nuget:?package=System.Formats.Cbor&version=8.0.0

About

Provides support for reading and writing values in Concise Binary Object Representation (CBOR) format, as originally defined in IETF RFC 7049.

Key Features

  • Reader and writer types for the CBOR format.
  • Built-in support for different CBOR conformance modes.

How to Use

Write and read primitives:

using System.Formats.Cbor;

var cborWriter = new CborWriter(CborConformanceMode.Lax);
cborWriter.WriteTextString("Hello World");

var cborReader = new CborReader(cborWriter.Encode(), CborConformanceMode.Lax);
Console.WriteLine(cborReader.ReadTextString());
// Hello World

Write and read an array:

var cborWriter = new CborWriter(CborConformanceMode.Lax);
cborWriter.WriteStartArray(5);
for (var index = 0; index < 5; index++)
{
    cborWriter.WriteInt32(index);
}
cborWriter.WriteEndArray();

var cborReader = new CborReader(cborWriter.Encode(), CborConformanceMode.Lax);
var arrayLength = cborReader.ReadStartArray();
for (var index = 0; index < arrayLength; index++)
{
    Console.Write(cborReader.ReadInt32());
}
// 01234
cborReader.ReadEndArray();

Inspect writer and reader state:

var cborWriter = new CborWriter(CborConformanceMode.Lax);
cborWriter.WriteTextString("SomeArray");
Console.WriteLine(cborWriter.BytesWritten);
// 10
Console.WriteLine(cborWriter.IsWriteCompleted);
// True

var cborReader = new CborReader(cborWriter.Encode(), CborConformanceMode.Lax);
Console.WriteLine(cborReader.BytesRemaining);
// 10
Console.WriteLine(cborReader.ReadTextString());
// SomeArray
Console.WriteLine(cborReader.BytesRemaining);
// 0

Main Types

The main types provided by this library are:

  • System.Formats.Cbor.CborReader
  • System.Formats.Cbor.CborWriter
  • System.Formats.Cbor.CborReaderState
  • System.Formats.Cbor.CborConformanceMode
  • System.Formats.Cbor.CborContentException
  • System.Formats.Cbor.CborTag

Additional Documentation

Feedback & Contributing

System.Formats.Cbor is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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. 
.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 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (15)

Showing the top 5 NuGet packages that depend on System.Formats.Cbor:

Package Downloads
Fido2

FIDO2 .NET library (WebAuthn)

Yubico.YubiKey

Yubico.YubiKey is the official .NET library for integrating with the YubiKey hardware authenticator. This library supports both macOS and Windows operating systems.

EdjCase.ICP.Agent

Package Description

System.Security.Cryptography.Cose The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides support for CBOR Object Signing and Encryption (COSE).

Blockfrost.Api

Services for interacting with the blockfrost api

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on System.Formats.Cbor:

Repository Stars
passwordless-lib/fido2-net-lib
FIDO2 .NET library for FIDO2 / WebAuthn Attestation and Assertion using .NET
dodobrands/WebAuthn.Net
WebAuthn (Passkeys) library for .NET.