https://github.com/teo-tsirpanis/covarsky

Enabling co(ntra)variance in F# types
https://github.com/teo-tsirpanis/covarsky

fsharp

Last synced: 22 days ago
JSON representation

Enabling co(ntra)variance in F# types

• Host: GitHub
• URL: https://github.com/teo-tsirpanis/covarsky
• Owner: teo-tsirpanis
• License: mit
• Created: 2020-01-30T23:29:15.000Z (almost 5 years ago)
• Default Branch: mainstream
• Last Pushed: 2022-09-01T23:01:08.000Z (about 2 years ago)
• Last Synced: 2024-10-02T14:16:38.339Z (about 1 month ago)
• Topics: fsharp
• Language: C#
• Homepage:
• Size: 60.5 KB
• Stars: 24
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![Licensed under the MIT License](https://img.shields.io/github/license/teo-tsirpanis/Covarsky.svg)

[![NuGet](https://img.shields.io/nuget/v/Covarsky.svg)][nuget]

[![CI build status](https://github.com/teo-tsirpanis/Covarsky/actions/workflows/ci.yml/badge.svg?branch=mainstream&event=push)](https://github.com/teo-tsirpanis/Covarsky/actions/workflows/ci.yml)

# Covarsky

Covarsky is a tool that brings co(ntra)variant types to F# or any other .ΝΕΤ language that does not natively support them. Powered by [Sigourney], it runs an MSBuild task that modifies assemblies after compilation.

## How to use

1. Add the [`Covarsky`][nuget] NuGet package to your project.

2. Create a new source file with two (or one, if you only need one kind of variance) attributes like that (F# example shown):

``` fsharp

namespace global

open System

[]

type internal CovariantOutAttribute() =

    inherit Attribute()

[]

type internal ContravariantInAttribute() =

    inherit Attribute()

```

> __Warning:__ The attributes must be declared in the global namespace, directly derive from the `Attribute` class and be internal.

3. You are good to go! Let's see an example.

``` fsharp

type MyType<[] 'T> =

    abstract GetObject: unit -> 'T

// [...]

let cast (x: MyType): MyType =

    unbox x

```

As you have seen, we have to perform manual type casts using `unbox` because F# does not recognize that `MyType`'s `'T` is covariant.

## Customizing Covarsky

### Using custom attribute names

If for any reason you want to customize the attribute names Covarsky will recognize, you can do it by specifying it in your project file:

``` xml

    MyLibrary.MakeItContravariantPleaseAttribute

    MyLibrary.MakeItCovariantPleaseAttribute

```

As you see, fully qualified names are accepted. The attribute classes however still have to be internal and belong to the same assembly.

### Disabling Covarsky

Since version 1.3.0 Covarsky is enabled by default when you install the package. If for any reason you want to disable it you can do it with the following property:

``` xml

    false

```

## Caveats

* ~~After Covarsky's execution, the two attributes will _not_ be removed.~~ Since version 1.4.0 the attributes will be removed from the generic parameters, allowing them to be trimmed by the IL Linker. User code should not rely on their existence.

* These two attributes will be ignored if used anywhere but in the generic parameters of an interface or a delegate.

* Using these two attributes in a generic parameter that is already co(ntra)variant will raise a warning but will be ignored as well.

* Using both attributes on the same generic parameter will raise an error and fail the build (unless something above hasn't already happened).

* _Using the attributes in any other wrong way (such as a contravariant interface with a method that returns the generic type) __will not be checked by Covarsky and may break your assembly.___

## Documentation

* [Errors and warnings](docs/errors-and-warnings.md)

## Maintainer(s)

- [@teo-tsirpanis](https://github.com/teo-tsirpanis)

[nuget]: https://nuget.org/packages/Covarsky

[sigourney]: https://github.com/teo-tsirpanis/Sigourney