Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kiryuumaru/DisposableHelpers
Disposable helpers for IDisposable and IAsyncDisposable
https://github.com/Kiryuumaru/DisposableHelpers
Last synced: 2 months ago
JSON representation
Disposable helpers for IDisposable and IAsyncDisposable
- Host: GitHub
- URL: https://github.com/Kiryuumaru/DisposableHelpers
- Owner: Kiryuumaru
- License: mit
- Created: 2022-02-17T19:31:22.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T19:33:18.000Z (3 months ago)
- Last Synced: 2024-10-24T06:14:13.286Z (3 months ago)
- Language: C#
- Homepage:
- Size: 187 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - https://github.com/Kiryuumaru/DisposableHelpers
README
# DisposableHelpers
Disposable helpers for IDisposable and IAsyncDisposable with source generators. Also capable of both anonymous disposable and anonymous async disposable.
**NuGets**
|Name|Info|
| ------------------- | :------------------: |
|DisposableHelpers|[](https://www.nuget.org/packages/DisposableHelpers/)|
## Installation
```csharp
// 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
```csharp
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
```csharp
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
```csharp
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
```csharp
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
```csharp
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
```csharp
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!.
[](https://ko-fi.com/kiryuumaru)