Benutomo.AutomaticDisposeImpl.SourceGenerator 0.0.0.1

A simple example of use

This is an experimental library, so there is no detailed documentation. Here is a simple example of how to use it.

SampleCode

namespace SampleCode
{
    class ConsoleOutputDisposable : IDisposable
    {
        public void Dispose()
        {
            Console.WriteLine("    Called Dispose() of ConsoleOutputDisposable.");
        }
    }

    class ConsoleOutputAsyncDisposable : IDisposable, IAsyncDisposable
    {
        public void Dispose()
        {
            Console.WriteLine("    Called Dispose() of ConsoleOutputAsyncDisposable.");
        }

        public ValueTask DisposeAsync()
        {
            Console.WriteLine("    Called DisposeAsync() of ConsoleOutputAsyncDisposable.");
            return default;
        }
    }

    [Benutomo.AutomaticDisposeImpl(ReleaseUnmanagedResourcesMethod = nameof(ReleaseUnmanagedResources))]
    public partial class DisposeableTest : IDisposable, IAsyncDisposable
    {
        ConsoleOutputDisposable consoleOutputDisposable = new();

        ConsoleOutputAsyncDisposable consoleOutputAsyncDisposable = new();

        public DisposeableTest()
        {
            Console.WriteLine("Created new DisposeableTest");
        }

        void ReleaseUnmanagedResources()
        {
            Console.WriteLine("    Called ReleaseUnmanagedResources() of DisposeableTest.");
        }
    }

    class Program
    {
        public static async Task Main()
        {
            await DiposeTestAsync();

            Console.WriteLine("Begin GC.Collect()");
            GC.Collect();
            GC.WaitForPendingFinalizers();
            Console.WriteLine("End GC.Collect()");
            Console.WriteLine();
        }

        static async Task DiposeTestAsync()
        {
            var disposeTestInstance = new DisposeableTest();

            Console.WriteLine("Begin disposeTestInstance.Dispose()");
            disposeTestInstance.Dispose();
            Console.WriteLine("End disposeTestInstance.Dispose()");
            Console.WriteLine();

            var asyncDisposeTestInstance = new DisposeableTest();

            Console.WriteLine("Begin disposeTestInstance.DisposeAsync()");
            await asyncDisposeTestInstance.DisposeAsync();
            Console.WriteLine("End disposeTestInstance.DisposeAsync()");
            Console.WriteLine();

            var garbegeCollectionTestInstance = new DisposeableTest();
        }
    }
}

Output example of above

Created new DisposeableTest
Begin disposeTestInstance.Dispose()
    Called Dispose() of ConsoleOutputDisposable.
    Called Dispose() of ConsoleOutputAsyncDisposable.
    Called ReleaseUnmanagedResources() of DisposeableTest.
End disposeTestInstance.Dispose()

Created new DisposeableTest
Begin disposeTestInstance.DisposeAsync()
    Called DisposeAsync() of ConsoleOutputAsyncDisposable.
    Called Dispose() of ConsoleOutputDisposable.
    Called ReleaseUnmanagedResources() of DisposeableTest.
End disposeTestInstance.DisposeAsync()

Created new DisposeableTest
Begin GC.Collect()
    Called ReleaseUnmanagedResources() of DisposeableTest. <-- Will be called by the finalizer even if Dispose is missed.
End GC.Collect()