{"id":13629201,"url":"https://github.com/polyadic/funcky-discriminated-union","last_synced_at":"2026-02-17T06:14:35.908Z","repository":{"id":42524283,"uuid":"429954211","full_name":"polyadic/funcky-discriminated-union","owner":"polyadic","description":"A source generator that generates Match methods for all your discriminated unions needs. ✨","archived":false,"fork":false,"pushed_at":"2025-02-04T10:19:33.000Z","size":147,"stargazers_count":7,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T23:48:40.225Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/polyadic.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"license-apache.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-19T22:49:03.000Z","updated_at":"2025-02-04T10:19:37.000Z","dependencies_parsed_at":"2025-01-07T17:58:59.195Z","dependency_job_id":"5bc16d56-946c-46cc-91a9-4d5b6766ed7f","html_url":"https://github.com/polyadic/funcky-discriminated-union","commit_stats":{"total_commits":48,"total_committers":2,"mean_commits":24.0,"dds":0.02083333333333337,"last_synced_commit":"d3b8a8f648664530d02c55e46153b7a42fbf2891"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyadic%2Ffuncky-discriminated-union","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyadic%2Ffuncky-discriminated-union/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyadic%2Ffuncky-discriminated-union/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polyadic%2Ffuncky-discriminated-union/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/polyadic","download_url":"https://codeload.github.com/polyadic/funcky-discriminated-union/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249316056,"owners_count":21249885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T22:01:04.440Z","updated_at":"2026-02-17T06:14:30.887Z","avatar_url":"https://github.com/polyadic.png","language":"C#","funding_links":[],"categories":["Content","Source Generators"],"sub_categories":["98. [Funcky.DiscriminatedUnion](https://ignatandrei.github.io/RSCG_Examples/v2/docs/Funcky.DiscriminatedUnion) , in the [FunctionalProgramming](https://ignatandrei.github.io/RSCG_Examples/v2/docs/rscg-examples#functionalprogramming) category","Functional Programming"],"readme":"# Funcky Discriminated Unions\nA source generator that generates `Match` methods for all your discriminated unions needs. ✨\n\n[![NuGet Version](https://img.shields.io/nuget/v/Funcky.DiscriminatedUnion)](https://www.nuget.org/packages/Funcky.DiscriminatedUnion)\n[![Build](https://github.com/polyadic/funcky-discriminated-union/workflows/Build/badge.svg)](https://github.com/polyadic/funcky-discriminated-union/actions?query=workflow%3ABuild)\n[![Licence: MIT](https://img.shields.io/badge/licence-MIT-green)](https://raw.githubusercontent.com/polyadic/funcky-discriminated-union/main/license-mit.txt)\n[![Licence: Apache](https://img.shields.io/badge/licence-Apache-green)](https://raw.githubusercontent.com/polyadic/funcky-discriminated-union/main/license-apache.txt)\n\n## Installation\nAdd `\u003cPackageReference Include=\"Funcky.DiscriminatedUnion\" Version=\"...\" PrivateAssets=\"all\" /\u003e` to your project file.\n\n## Usage\nApply the `[DiscriminatedUnion]` to an abstract class (or record) with nested types representing the variants.\n\n## Example\n```cs\nusing Funcky;\n\nvar result = Result\u003cint\u003e.Ok(42);\nvar resultOrFallback = result.Match(ok: ok =\u003e ok.Value, error: _ =\u003e 0);\n\n[DiscriminatedUnion]\npublic abstract partial record Result\u003cT\u003e\n    where T : notnull\n{\n    public sealed partial record Ok(T Value) : Result\u003cT\u003e;\n\n    public sealed partial record Error(Exception Exception) : Result\u003cT\u003e;\n}\n```\n\n## Minimum Required Versions\n* Visual Studio 2022\n* Roslyn 4.0.0\n* .NET 6\n\n## Settings\nThe attribute allows configuration of some aspects of source generation.\n\n### `NonExhaustive`\nThe auto-generated `Match` and `Switch` methods are public by default.\nWhen `NonExhaustive` is set to `true`, these methods are generated with `internal` visibility instead.\n\n### `MatchResultTypeName`\nThe auto-generated `Match` method uses a generic type for the result. This type is named `TResult` by default.\nThis can cause conflict with generic types on the discriminated union itself. Use `MatchResultTypeName` to set a custom name for this type.\n\n```cs\nusing Funcky;\n\n[DiscriminatedUnion(MatchResultTypeName = \"TMatchResult\")]\npublic abstract partial record Result\u003cTResult\u003e { ... }\n\n// Generated code\npartial record Result\u003cTResult\u003e\n{\n    public abstract TMatchResult Match\u003cTMatchResult\u003e(...);\n\n    ...\n}\n```\n\n### `Flatten`\nThe auto-generated `Match` and `Switch` methods only accept one level of inheritance by default.\nSet `Flatten` to `true` to include arbitrarily deep inherited types in these methods.\n\n```cs\nusing Funcky;\n\nSyntaxNode node = ...;\nvar nodeAsString = node.Match(\n    keyword: keyword =\u003e keyword.Value,\n    integer: integer =\u003e integer.Value.ToString(),\n    double: @double =\u003e @double.Value.ToString());\n\n[DiscriminatedUnion(Flatten = true)]\npublic abstract partial record SyntaxNode\n{\n    public sealed partial record Keyword(string Value) : SyntaxNode;\n\n    public abstract partial record Literal : SyntaxNode;\n\n    public abstract partial record Number : Literal;\n\n    public sealed partial record Integer(int Value) : Number;\n\n    public sealed partial record Double(double Value) : Number;\n}\n```\n\n### `[JsonPolymorphic]`\nSystem.Text.Json adds support for [serializing derived classes][json-polymorphism-docs] starting with .NET 7.\nThis generator supports this feature by generating the required `[JsonDerivedType]` attributes for you.\n\nAll missing `[JsonDerivedType]` attributes are generated if at least one `[JsonDerivedType]` or `[JsonPolymorphic]`\nattribute is specified.\n\n```cs\nusing Funcky;\nusing System.Text.Serialization;\n\n[DiscriminatedUnion]\n[JsonPolymorphic]\npublic abstract partial record Shape\n{\n    public sealed partial record Rectangle(double Width, double Length) : Shape;\n\n    public sealed partial record Circle(double Radius) : Shape;\n\n    public sealed partial record EquilateralTriangle(double SideLength) : Shape;\n}\n```\n\n\u003cdetails\u003e\n\n\u003csummary\u003eGenerated code\u003c/summary\u003e\n\n```cs\nusing System.Text.Serialization;\n\n[JsonDerivedType(typeof(Rectangle), typeDiscriminator: nameof(Rectangle))]\n[JsonDerivedType(typeof(Circle), typeDiscriminator: nameof(Circle))]\n[JsonDerivedType(typeof(EquilateralTriangle), typeDiscriminator: nameof(EquilateralTriangle))]\npartial record Shape\n{\n    // ...\n}\n```\n\n\u003c/details\u003e\n\n\n### `GeneratePartitionExtension`\nSet `GeneratePartitionExtension` to true to auto-generate partition methods for `IEnumerable\u003cT\u003e` of your type.\n\n```cs\nusing Funcky;\nusing System.Text.Serialization;\n\n[DiscriminatedUnion(GeneratePartitionExtension = true)]\npublic abstract partial record Result\n{\n    public sealed partial record Ok() : Result;\n\n    public sealed partial record Warning(string Message) : Result;\n\n    public sealed partial record Error(string Message) : Result;\n}\n```\n\n\u003cdetails\u003e\n\n\u003csummary\u003eUsage\u003c/summary\u003e\n\n```cs\nvar results = new Result[] { new Result.Ok(), /* ... */ }\n\n// N-Tuple extension method:\nvar (oks, warnings, errors) = results.Partition();\n\n// Extension method with result selector:\nvar warningAndErrorCount = results.Partition(resultSelector: (_, warnings, errors) =\u003e warnings.Count + errors.Count);\n```\n\n\u003c/details\u003e\n\n[json-polymorphism-docs]: https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyadic%2Ffuncky-discriminated-union","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolyadic%2Ffuncky-discriminated-union","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyadic%2Ffuncky-discriminated-union/lists"}