Oakrey.Disposables 3.0.0

Oakrey.Disposables

1. Overview

The Disposables project provides utilities for managing disposable resources in .NET applications. It simplifies the implementation of the IDisposable pattern by offering base classes, disposable collections, fluent registration helpers, and action-based cleanup wrappers.

2. Features

DisposableBase:

• Abstract base class for implementing the IDisposable pattern.
• Manages a collection of child disposable objects.
• Provides idempotent disposal and a protected ThrowIfDisposed() helper for derived classes.

DisposableCollection:

• Holds multiple IDisposable objects and disposes them together.
• Is thread-safe for adding and disposing items.
• Disposes items in reverse registration order.
• Keeps Dispose() non-throwing and exposes explicit exception-aware methods:
  • DisposeAndCollectExceptions()
  • DisposeAndThrow()

DisposableAction:

• Wraps an Action as an IDisposable instance.
• Invokes the action at most once.

Fluent Extensions:

• Adds disposable objects or cleanup actions to a DisposableCollection using Append(...).

3. Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
3. Search for Oakrey.Disposables and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Disposables

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Disposables

4. Usage

using DisposableCollection disposables = new();

Stream stream = disposables.Add(File.OpenRead("data.bin"));
disposables.Add(() => Console.WriteLine("cleanup finished"));

Use explicit exception-aware disposal when cleanup failures must be handled:

IReadOnlyList<Exception> exceptions = disposables.DisposeAndCollectExceptions();

5. Requirements

• .NET 10 or higher

6. Project Information

• Author: Oakrey
• Company: Oakrey (Website Link)
• License: MIT
• Repository: Git Repository
• Project URL: Project Website

7. Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

8. License

This project is licensed under the MIT License. See the LICENSE file for details.