Covarsky 1.3.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package Covarsky --version 1.3.1

NuGet\Install-Package Covarsky -Version 1.3.1

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="Covarsky" Version="1.3.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Covarsky --version 1.3.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Covarsky, 1.3.1"

#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 Covarsky as a Cake Addin
#addin nuget:?package=Covarsky&version=1.3.1

// Install Covarsky as a Cake Tool
#tool nuget:?package=Covarsky&version=1.3.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Licensed under the MIT License

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

Add the Covarsky NuGet package to your project.
Create a new source file with two (or one, if you only need one kind of variance) attributes like that (F# example shown):

namespace global

open System

[<AttributeUsage(AttributeTargets.GenericParameter)>]
type internal CovariantOutAttribute() =
    inherit Attribute()

[<AttributeUsage(AttributeTargets.GenericParameter)>]
type internal ContravariantInAttribute() =
    inherit Attribute()

Warning: The attributes must be declared in the global namespace, and must be internal.

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

type MyType<[<CovariantOut>] 'T> =
    abstract GetObject: unit -> 'T

// [...]

let cast (x: MyType<string>): MyType<obj> =
    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:

<PropertyGroup>
    <CustomInAttributeName>MyLibrary.MakeItContravariantPleaseAttribute</CustomInAttributeName>
    <CustomOutAttributeName>MyLibrary.MakeItContravariantPleaseAttribute</CustomOutAttributeName>
</PropertyGroup>

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 some reason you want to disable it you can do it with the following property:

<PropertyGroup>
    <CovarskyEnable>false</CovarskyEnable>
</PropertyGroup>

Caveats

After Covarsky's execution, the two attributes will not be removed.
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 time 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.