Merge pull request #1 from polyadic/improvements

Directory.Build.props

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
 	<PropertyGroup>
-		<Version>0.1.0</Version>
+		<Version>0.2.0</Version>
 	</PropertyGroup>
 	<PropertyGroup Label="Shared NuGet Metadata">
 		<Authors>Polyadic</Authors>

Dispownership.sln

@@ -13,6 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.gitattributes = .gitattributes
 		.gitignore = .gitignore
 		readme.md = readme.md
+		changelog.md = changelog.md
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build Config", "Build Config", "{688F10E7-1CEB-412E-A9A8-8BD16F2BDED5}"

Dispownership/AsyncDisposable.cs

@@ -19,20 +19,26 @@ public static AsyncDisposable<TDisposable> Owned<TDisposable>(TDisposable value)
         where TDisposable : IAsyncDisposable
         => new(value, hasOwnership: true);
 
+    /// <summary>Creates a owned wrapper around a disposable i.e. the disposable will be disposed when the wrapper is disposed.</summary>
+    /// <remarks>This overload is useful to communicate the ownership to analyzers such as <c>IDisposableAnalyzers</c>.</remarks>
+    public static AsyncDisposable<TDisposable> Owned<TDisposable>(Func<TDisposable> createValue)
+        where TDisposable : IAsyncDisposable
+        => Owned(createValue());
+
     /// <summary>Creates a borrowing wrapper around a disposable i.e. the disposable will not be disposed when the wrapper is disposed.</summary>
     public static AsyncDisposable<TDisposable> Borrowed<TDisposable>(TDisposable value)
         where TDisposable : IAsyncDisposable
         => new(value, hasOwnership: false);
 }
 
 /// <summary>A wrapper around an <see cref="IAsyncDisposable"/> that either owns or borrows the value.
-/// Use <see cref="AsyncDisposable.Owned{TDisposable}"/> or <see cref="AsyncDisposable.Borrowed{TDisposable}"/> to create an instance of this wrapper.</summary>
+/// Use <see cref="AsyncDisposable.Owned{TDisposable}(TDisposable)"/> or <see cref="AsyncDisposable.Borrowed{TDisposable}"/> to create an instance of this wrapper.</summary>
 #if DISPOWNERSHIP_VISIBILITY_PUBLIC
 public
 #else
 internal
 #endif
-struct AsyncDisposable<TDisposable> : IAsyncDisposable
+sealed class AsyncDisposable<TDisposable> : IAsyncDisposable
     where TDisposable : IAsyncDisposable
 {
     private readonly TDisposable _inner;

Dispownership/Disposable.cs

@@ -17,20 +17,26 @@ public static Disposable<TDisposable> Owned<TDisposable>(TDisposable value)
         where TDisposable : IDisposable
         => new(value, hasOwnership: true);
 
+    /// <summary>Creates a owned wrapper around a disposable i.e. the disposable will be disposed when the wrapper is disposed.</summary>
+    /// <remarks>This overload is useful to communicate the ownership to analyzers such as <c>IDisposableAnalyzers</c>.</remarks>
+    public static Disposable<TDisposable> Owned<TDisposable>(Func<TDisposable> createValue)
+        where TDisposable : IDisposable
+        => Owned(createValue());
+
     /// <summary>Creates a borrowing wrapper around a disposable i.e. the disposable will not be disposed when the wrapper is disposed.</summary>
     public static Disposable<TDisposable> Borrowed<TDisposable>(TDisposable value)
         where TDisposable : IDisposable
         => new(value, hasOwnership: false);
 }
 
 /// <summary>A wrapper around an <see cref="IDisposable"/> that either owns or borrows the value.
-/// Use <see cref="Disposable.Owned{TDisposable}"/> or <see cref="Disposable.Borrowed{TDisposable}"/> to create an instance of this wrapper.</summary>
+/// Use <see cref="Disposable.Owned{TDisposable}(TDisposable)"/> or <see cref="Disposable.Borrowed{TDisposable}"/> to create an instance of this wrapper.</summary>
 #if DISPOWNERSHIP_VISIBILITY_PUBLIC
 public
 #else
 internal
 #endif
-struct Disposable<TDisposable> : IDisposable
+sealed class Disposable<TDisposable> : IDisposable
     where TDisposable : IDisposable
 {
     private readonly TDisposable _inner;

changelog.md

@@ -0,0 +1,7 @@
+# Changelog
+## 0.2.0
+* Add convenience overload for `Disposable.Owned` that helps with analyzers such as `IDisposableAnalyzers`.
+* Use class instead of struct for `Disposable<T>` and `AsyncDisposable<T>`.
+
+## 0.1.0
+Initial release