Metalama.Patterns.Immutability 2024.2.10-preview

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.7.1 This package targets .NET Framework 4.7.1. The package is compatible with this framework or higher.
This is a prerelease version of Metalama.Patterns.Immutability.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Metalama.Patterns.Immutability --version 2024.2.10-preview
NuGet\Install-Package Metalama.Patterns.Immutability -Version 2024.2.10-preview
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="Metalama.Patterns.Immutability" Version="2024.2.10-preview" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Metalama.Patterns.Immutability --version 2024.2.10-preview
#r "nuget: Metalama.Patterns.Immutability, 2024.2.10-preview"
#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 Metalama.Patterns.Immutability as a Cake Addin
#addin nuget:?package=Metalama.Patterns.Immutability&version=2024.2.10-preview&prerelease

// Install Metalama.Patterns.Immutability as a Cake Tool
#tool nuget:?package=Metalama.Patterns.Immutability&version=2024.2.10-preview&prerelease

Metalama Logo

About

The Metalama.Patterns.Immutability implements the concept of immutable type, i.e. types whose value cannot be changed after they have been created. Other packages, such as Metalama.Patterns.Observability, can then rely on this concept to achieve a better understanding of the code.

Key Features

  • You can mark types as immutable using the [Immutable] custom attribute or the ConfigreImmutability fabric extension warning.
  • Concept of shallow or deep immutability.
  • The [Immutable] aspect reports warnings if some fields or properties are not mutable.

Main Types

The primary types in this package are:

  • ImmutabilityKind represents the kind of immutability of a type, i.e. None, Shallow or Deep.
  • ImmutableAttribute is an aspect that marks a type as immutable and reports warnings if some fields or properties are mutable.
  • ImmutabilityExtensions.GetImmutability is an extension of INamedType to get the ImmutabilityKind of a given type.
  • ImmutabilityConfigurationExtensions.ConfigureImmutability is a fabric extension method to programmatically set the ImmutabilityKind of types.
  • IImmutabilityClassifier is an abstraction whose implementations can be passed to ImmutabilityConfigurationExtensions.ConfigureImmutability to dynamically return the ImmutabilityKind of a kind. It is useful when the ImmutabilityKind depends on type arguments.

Additional Documentation

  • Conceptual documentation: TODO.
  • API documentation: TODO.
  • Metalama.Patterns.Observability relies on Metalama.Patterns.Immutability to decide which method calls are supported in property getters.
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 was computed.  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 was computed.  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 was computed.  net463 was computed.  net47 was computed.  net471 is compatible.  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 (1)

Showing the top 1 NuGet packages that depend on Metalama.Patterns.Immutability:

Package Downloads
Metalama.Patterns.Observability The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Implements the Observable pattern and the INotifyPropertyChanged interface with a single [Observable] attribute thanks to Metalama. Supports both automatic and explicit properties and child objects.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2024.2.12-preview 25 6/28/2024
2024.2.11-preview 32 6/26/2024
2024.2.10-preview 43 6/20/2024
2024.2.9-preview 43 6/11/2024