Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linksplatform/disposables
LinksPlatform's Platform.Disposables Class Library
https://github.com/linksplatform/disposables
class-library csharp dotnet-framework dotnet-standard linksplatform
Last synced: about 2 months ago
JSON representation
LinksPlatform's Platform.Disposables Class Library
- Host: GitHub
- URL: https://github.com/linksplatform/disposables
- Owner: linksplatform
- License: unlicense
- Created: 2019-07-11T16:54:18.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T20:06:48.000Z (10 months ago)
- Last Synced: 2024-04-16T00:51:28.564Z (9 months ago)
- Topics: class-library, csharp, dotnet-framework, dotnet-standard, linksplatform
- Language: C#
- Homepage: https://linksplatform.github.io/Disposables
- Size: 2.49 MB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/Platform.Disposables)
[](https://github.com/linksplatform/Disposables/actions?workflow=csharp)
[](https://app.codacy.com/gh/linksplatform/Disposables?utm_source=github.com&utm_medium=referral&utm_content=linksplatform/Disposables&utm_campaign=Badge_Grade_Settings)
[](https://www.codefactor.io/repository/github/linksplatform/disposables)
# [Disposables](https://github.com/linksplatform/Disposables) ([русская версия](README.ru.md))
This library helps to make objects disposable in a fast, short, easy and safe way. Say goodbye to memory leaks one at time :)
`Platform.Disposables.DisposableBase` abstract class tries to dispose the object at both on instance destruction and `OnProcessExit` whatever comes first even if `Dispose` method was not called anywhere by user. And takes care your disposal logic executes only once by default, and if you really need it, you can allow multiple calls and attempts to dispose, by overriding corresponding properties.
The `Platform.Disposables.IDisposable` interface extends the `System.IDisposable` with `IsDisposed` property and `Destruct` method. The `Destruct` method is designed to never throw exceptions, that makes it safe to use in class destructors. All ignored exceptions are available at `Platform.Disposables.IgnoredDisposables` if you need to debug them.
Namespace: [Platform.Disposables](https://linksplatform.github.io/Disposables/csharp/api/Platform.Disposables.html)
Forked from: [Konard/LinksPlatform/Platform/Platform.Helpers/Disposables](https://github.com/Konard/LinksPlatform/tree/708f6143645333781adae0cad7ae998fefcd6317/Platform/Platform.Helpers/Disposables)
Package at NuGet: [Platform.Disposables](https://www.nuget.org/packages/Platform.Disposables)
## Examples
If you can use inheritance in your class. For example if you don't have other base class inherited.
```C#
using Platform.Disposables;
namespace Examples
{
public class DisposableBaseUsageExample : DisposableBase
{
protected override void Dispose(bool manual, bool wasDisposed)
{
// Put your dispose logic in this method
if (!wasDisposed)
{
// First call from Dispose or Destructor
}
else
{
// (IsDisposed == true) here, Dispose called twise, or Dispose and Destructor were called
if (manual)
{
// Call from IDisposable.Dispose()
}
else
{
// Call from Destructor
}
}
}
}
}
```
If you cannot use inheritance in your class. For example if you have other base class inherited.
```C#
using Platform.Disposables;
namespace Examples
{
public class DisposableUsageExample : System.IDisposable
{
private readonly Disposable _disposable;
public DisposableUsageExample() => _disposable = new Disposable(Disposed);
public void Dispose() => _disposable.Dispose();
~DisposableUsageExample() => _disposable.Destruct();
private void Disposed(bool manual, bool wasDisposed)
{
// Dispose logic
}
}
}
```
If you do not have access to the internal structure of the object's class. You can use a disposable object container. The container is convertible back to the passed object at any time.
```C#
using Platform.Disposables;
namespace Examples
{
public class Examples
{
public static void UseAndDispose()
{
var array = new int[] { 1, 2, 3 };
Disposable disposableArray = (array, () => array = null);
WorkWithObjectAndDispose(disposableArray);
// Here array == null
}
private static void WorkWithObjectAndDispose(Disposable disposableArray)
{
using (disposableArray)
{
int[] array = disposableArray;
// Use your object here
} // Here there is call to () => array = null
}
}
}
```
## [Documentation](https://linksplatform.github.io/Disposables)
* Interface [IDisposable](https://linksplatform.github.io/Disposables/csharp/api/Platform.Disposables.IDisposable.html).
* Abstract class [DisposableBase](https://linksplatform.github.io/Disposables/csharp/api/Platform.Disposables.DisposableBase.html).
* Class [Disposable](https://linksplatform.github.io/Disposables/csharp/api/Platform.Disposables.Disposable.html).
* Class [Disposable\](https://linksplatform.github.io/Disposables/csharp/api/Platform.Disposables.Disposable-1.html).
[PDF file](https://linksplatform.github.io/Disposables/csharp/Platform.Disposables.pdf) with code for e-readers.
## Depend on
* [Platform.Exceptions](https://github.com/linksplatform/Exceptions)
## Dependent libraries
* [Platform.Collections](https://github.com/linksplatform/Collections)