PolyType 0.18.2
See the version list below for details.
dotnet add package PolyType --version 0.18.2
NuGet\Install-Package PolyType -Version 0.18.2
<PackageReference Include="PolyType" Version="0.18.2" />
paket add PolyType --version 0.18.2
#r "nuget: PolyType, 0.18.2"
// Install PolyType as a Cake Addin #addin nuget:?package=PolyType&version=0.18.2 // Install PolyType as a Cake Tool #tool nuget:?package=PolyType&version=0.18.2
PolyType
PolyType is a practical polytypic programming library for .NET. It facilitates the rapid development of high-performance, feature-complete libraries that interact with user-defined types such as structured loggers, mappers, validators, parsers, random generators, and equality comparers. Its built-in source generator ensures that any library built on top of the PolyType gets Native AOT support for free.
The project is a port of the TypeShape library for F#, adapted to patterns and idioms available in C#.
See the project website for additional background and API documentation.
Quick Start
You can try the library by installing the PolyType
NuGet package:
$ dotnet add package PolyType
which includes the core types and source generator for generating type shapes:
using PolyType;
[GenerateShape]
public partial record Person(string name, int age);
Doing this will augment Person
with an implementation of the IShapeable<Person>
interface. This suffices to make Person
usable with any library that targets the PolyType core abstractions. You can try this out by installing the built-in example libraries:
$ dotnet add package PolyType.Examples
Here's how the same value can be serialized to three separate formats.
using PolyType.Examples.JsonSerializer;
using PolyType.Examples.CborSerializer;
using PolyType.Examples.XmlSerializer;
Person person = new("Pete", 70);
JsonSerializerTS.Serialize(person); // {"Name":"Pete","Age":70}
XmlSerializer.Serialize(person); // <value><Name>Pete</Name><Age>70</Age></value>
CborSerializer.EncodeToHex(person); // A2644E616D656450657465634167651846
Since the application uses a source generator to produce the shape for Person
, it is fully compatible with Native AOT. See the shape providers article for more details on how to use the library with your types.
Authoring PolyType Libraries
As a library author, PolyType makes it easy to write high-performance, feature-complete components by targeting its core abstractions. For example, a parser API using PolyType might look as follows:
public static class MyFancyParser
{
public static T? Parse<T>(string myFancyFormat) where T : IShapeable<T>;
}
The IShapeable<T>
constraint indicates that the parser only works with types augmented with PolyType metadata. This metadata can be provided using the PolyType source generator:
Person? person = MyFancyParser.Parse<Person>(format); // Compiles
[GenerateShape] // Generate an IShapeable<TPerson> implementation
partial record Person(string name, int age, List<Person> children);
For more information see:
- The core abstractions document for an overview of the core programming model.
- The shape providers document for an overview of the built-in shape providers and their APIs.
- The generated API documentation for the project.
- The
PolyType.Examples
project for advanced examples of libraries built on top of PolyType.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | 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. |
-
net8.0
- No dependencies.
NuGet packages (3)
Showing the top 3 NuGet packages that depend on PolyType:
Package | Downloads |
---|---|
PolyType.TestCases
Practical generic programming for C# |
|
PolyType.Examples
Practical generic programming for C# |
|
Nerdbank.MessagePack
A fast and more user-friendly MessagePack serialization library for .NET. With ground-up support for trimming and Native AOT. |
GitHub repositories
This package is not used by any popular GitHub repositories.