DisposableHelpers 1.2.1

This package has a SemVer 2.0.0 package version: 1.2.1+build.9.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DisposableHelpers --version 1.2.1                
NuGet\Install-Package DisposableHelpers -Version 1.2.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="DisposableHelpers" Version="1.2.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DisposableHelpers --version 1.2.1                
#r "nuget: DisposableHelpers, 1.2.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 DisposableHelpers as a Cake Addin
#addin nuget:?package=DisposableHelpers&version=1.2.1

// Install DisposableHelpers as a Cake Tool
#tool nuget:?package=DisposableHelpers&version=1.2.1                

DisposableHelpers

Disposable helpers for IDisposable and IAsyncDisposable with source generators. Also capable of both anonymous disposable and anonymous async disposable.

NuGets

Name Info
DisposableHelpers NuGet

Installation

// Install release version
Install-Package DisposableHelpers

// Install pre-release version
Install-Package DisposableHelpers -pre

Supported frameworks

.NET Standard 2.0 and above - see https://github.com/dotnet/standard/blob/master/docs/versions.md for compatibility matrix

Usage

Disposable

using DisposableHelpers;

namespace YourNamespace
{
    public class SampleDisposable : Disposable
    {
        private SampleUnmanagedResource resources;
        
        protected override void Dispose(bool disposing)
        {
            if (disposing)
            {
                resources.Release();
            }
            base.Dispose(disposing);
        }
    }
}

Disposable Source Generator

using DisposableHelpers.Attributes;

namespace YourNamespace
{
    [Disposable]
    public partial class SampleDisposable
    {
        private SampleUnmanagedResource resources;
        
        protected void Dispose(bool disposing)
        {
            if (disposing)
            {
                resources.Release();
            }
            base.Dispose(disposing);
        }
    }
}

Anonymous Disposable

using DisposableHelpers;

namespace YourNamespace
{
    public static class Program
    {
        private static SampleUnmanagedResource resources;
        
        public static void Main(string[] args)
        {
            Disposable disposable = new Disposable(disposing =>
            {
                if (disposing)
                {
                    resources.Release();
                }
            });

            disposable.Dispose();
        }
    }
}

AsyncDisposable

using DisposableHelpers;

namespace YourNamespace
{
    public class SampleAsyncDisposable : AsyncDisposable
    {
        private SampleAsyncUnmanagedResource resources;
        
        protected override async ValueTask Dispose(bool isDisposing)
        {
            if (isDisposing)
            {
                await resources.Release();
            }
            return base.Dispose(isDisposing);
        }
    }
}

AsyncDisposable Source Generator

using DisposableHelpers.Attributes;

namespace YourNamespace
{
    [AsyncDisposable]
    public partial class SampleAsyncDisposable
    {
        private SampleAsyncUnmanagedResource resources;
        
        protected async ValueTask Dispose(bool isDisposing)
        {
            if (isDisposing)
            {
                await resources.Release();
            }
            return base.Dispose(isDisposing);
        }
    }
}

Anonymous AsyncDisposable

using DisposableHelpers;

namespace YourNamespace
{
    public static class Program
    {
        private static SampleAsyncUnmanagedResource resources;
        
        public static async void Main(string[] args)
        {
            AsyncDisposable disposable = new AsyncDisposable(async disposing =>
            {
                if (disposing)
                {
                    await resources.Release();
                }
            });

            await disposable.DisposeAsync();
        }
    }
}

Want To Support This Project?

All I have ever asked is to be active by submitting bugs, features, and sending those pull requests down!.

paypal

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 is compatible.  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 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. 
.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 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  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 (2)

Showing the top 2 NuGet packages that depend on DisposableHelpers:

Package Downloads
LockerHelpers

Provides helpers for execution locking mechanism.

SingletonSessionHelpers

Provides a base API for singleton session design pattern.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.58 34 11/8/2024
1.2.57 13 11/8/2024
1.2.56 15 11/8/2024
1.2.55 19 11/8/2024
1.2.54 29 11/7/2024
1.2.53 153 11/6/2024
1.2.52 24 11/6/2024
1.2.51 151 11/5/2024
1.2.50 268 10/30/2024
1.2.49 122 10/30/2024
1.2.48 155 10/29/2024
1.2.47 238 10/28/2024
1.2.46 46 10/25/2024
1.2.45 308 10/23/2024
1.2.44 219 10/22/2024
1.2.43 307 10/17/2024
1.2.42 312 10/14/2024
1.2.41 255 10/11/2024
1.2.40 489 10/7/2024
1.2.39 263 10/4/2024
1.2.38 243 10/2/2024
1.2.37 249 9/27/2024
1.2.36 35 9/27/2024
1.2.35 46 9/27/2024
1.2.34 343 9/25/2024
1.2.33 135 9/25/2024
1.2.32 238 9/23/2024
1.2.31 41 9/23/2024
1.2.30 233 9/20/2024
1.2.29 113 9/20/2024
1.2.28 266 9/18/2024
1.2.27 146 9/16/2024
1.2.26 276 9/10/2024
1.2.24 344 9/5/2024
1.2.23 358 8/29/2024
1.2.22 254 8/26/2024
1.2.21 218 8/22/2024
1.2.20 47 8/22/2024
1.2.19 46 8/22/2024
1.2.18 155 8/20/2024
1.2.17 355 8/14/2024
1.2.16 135 8/13/2024
1.2.15 380 7/31/2024
1.2.14 63 7/31/2024
1.2.13 117 7/26/2024
1.2.12 469 7/16/2024
1.2.11 95 7/15/2024
1.2.10 85 7/13/2024
1.2.9 101 7/12/2024
1.2.8 123 7/9/2024
1.2.7 102 7/8/2024
1.2.6 45 7/8/2024
1.2.5 47 7/8/2024
1.2.4 135 7/7/2024
1.2.3 199 7/1/2024
1.2.2 93 6/30/2024
1.2.1 106 6/28/2024
1.2.0 197 5/3/2024
1.1.16 1,373 10/3/2023
1.1.15 312 8/30/2023
1.1.14 247 8/28/2023
1.1.13 274 8/8/2023
1.1.12 269 7/11/2023
1.1.11 159 7/9/2023
1.1.10 235 6/20/2023
1.1.9 1,747 9/8/2022
1.1.8 387 9/4/2022
1.1.7 400 9/4/2022
1.1.6 2,685 7/20/2022
1.1.5 420 7/20/2022
1.1.4 453 7/17/2022
1.1.3 398 7/17/2022
1.1.2 462 7/17/2022
1.1.1 422 7/17/2022
1.1.0 466 7/17/2022
1.0.2 3,863 3/7/2022
1.0.1 3,283 2/21/2022
1.0.0 1,197 2/17/2022

## What's Changed
* Bump xunit.runner.visualstudio from 2.5.1 to 2.5.3 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/13
* Bump xunit from 2.5.1 to 2.5.2 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/14
* Bump xunit from 2.5.2 to 2.5.3 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/15
* Bump xunit from 2.5.3 to 2.6.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/16
* Bump xunit from 2.6.0 to 2.6.1 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/17
* Bump Microsoft.NET.Test.Sdk from 17.7.2 to 17.8.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/18
* Bump xunit from 2.6.1 to 2.6.2 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/20
* Bump xunit.runner.visualstudio from 2.5.3 to 2.5.4 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/21
* Bump Microsoft.CodeAnalysis.CSharp from 4.7.0 to 4.8.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/22
* Bump xunit from 2.6.2 to 2.6.3 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/23
* Bump xunit.runner.visualstudio from 2.5.4 to 2.5.6 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/25
* Bump xunit from 2.6.3 to 2.6.5 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/27
* Bump xunit from 2.6.5 to 2.6.6 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/28
* Bump Microsoft.NET.Test.Sdk from 17.8.0 to 17.9.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/29
* Bump xunit from 2.6.6 to 2.7.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/30
* Bump coverlet.collector from 6.0.0 to 6.0.1 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/32
* Bump xunit.runner.visualstudio from 2.5.6 to 2.5.7 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/31
* Bump Microsoft.CodeAnalysis.CSharp from 4.8.0 to 4.9.2 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/33
* Bump coverlet.collector from 6.0.1 to 6.0.2 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/34
* Bump xunit.runner.visualstudio from 2.5.7 to 2.5.8 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/35
* Bump xunit from 2.7.0 to 2.8.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/37
* Bump xunit.runner.visualstudio from 2.5.8 to 2.8.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/38
* Bump Microsoft.NET.Test.Sdk from 17.9.0 to 17.10.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/39
* Bump xunit.runner.visualstudio from 2.8.0 to 2.8.1 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/40
* Bump Microsoft.CodeAnalysis.CSharp from 4.9.2 to 4.10.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/42
* Bump xunit from 2.8.0 to 2.8.1 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/41
* Updated CICD by @Kiryuumaru in https://github.com/Kiryuumaru/DisposableHelpers/pull/43
* Bump Microsoft.Bcl.AsyncInterfaces from 7.0.0 to 8.0.0 by @dependabot in https://github.com/Kiryuumaru/DisposableHelpers/pull/19

## New Contributors
* @Kiryuumaru made their first contribution in https://github.com/Kiryuumaru/DisposableHelpers/pull/43

**Full Changelog**: https://github.com/Kiryuumaru/DisposableHelpers/compare/build.7...build.9