Version 1.1.0: .NET 8 and IUnsafeDisposable interface.

Author: Azengar

README.md

@@ -9,6 +9,15 @@ Provides faster alternatives to `Memory<T>` and `ReadOnlyMemory<T>` in addition
 
 Allows to manipulate array of unmanaged pointers with the `UnmanagedArrayPointer<T>` struct.
 
+## Making a release
+
+* Generate new commit with your changes with a message: `git commit -m "Version X.X.X: Notes about the change"`
+* Tag the new commit: `git tag vX.X.X -m "Version X.X.X"`
+* Push the commit: `git push` and the tag `git push origin vX.X.X`
+* Build the new `Release` binaries. The package is built automatically alongside the binaries.
+* Navigate to `./UnmanagedMemoryUtils/UnmanagedMemoryUtils/bin/Release`
+* Publish the package: `dotnet nuget push .\UnmanagedMemoryUtils.X.X.X.nupkg --api-key <YOUR_API_KEY> --source https://api.nuget.org/v3/index.json`
+
 ## Changelog
 
 ### Version 1.0.2
@@ -31,4 +40,10 @@ Allows to manipulate array of unmanaged pointers with the `UnmanagedArrayPointer
 
 ### Version 1.0.6
 
-* Readme update with Nuget link.
+* Readme update with Nuget link.
+
+### Version 1.1.0
+
+* Update to .NET 8
+* Adds a new `IUnsafeDisposable` interface which offers an unsafe but less performance impacting to the standard `IDisposable` and finalizer pattern.
+	* This interface is now implemented by `IUnmanagedString` and is available to use outside the library.

UnmanagedMemoryUtils/UnmanagedMemoryUtils/IUnmanagedString.cs

@@ -3,7 +3,7 @@
     /// <summary>
     /// Represents an unmanaged string most basic form.
     /// </summary>
-    public interface IUnmanagedString
+    public interface IUnmanagedString : IUnsafeDisposable
     {
         nint Pointer { get; }
         string ToString();

UnmanagedMemoryUtils/UnmanagedMemoryUtils/IUnsafeDisposable.cs

@@ -0,0 +1,18 @@
+namespace UnmanagedMemoryUtils;
+
+/// <summary>
+/// Represents an object that contains native resources which should be freed, using the <see cref="Free"/> method.
+/// </summary>
+/// <remarks>
+/// This interface differs of the .NET <see cref="IDisposable"/> implementation in that it is not expected 
+/// to be used alongside a finalizer to avoid the performance penalty, it is your responsibility to call <see cref="Free"/> 
+/// and you will face memory leaks if you don't do so consistently. So it is a tradeoff of adding more responsibility on the developer in favor of performance.
+/// </remarks>
+public interface IUnsafeDisposable
+{
+    /// <summary>
+    /// Free the native resources used as part of this object. 
+    /// It is not neceessary to free managed resources altough it can also be done if so wished.
+    /// </summary>
+    void Free();
+}

UnmanagedMemoryUtils/UnmanagedMemoryUtils/UnmanagedMemoryUtils.csproj

@@ -1,13 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFramework>net7.0</TargetFramework>
+		<TargetFramework>net8.0</TargetFramework>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 		<AllowUnsafeBlocks>True</AllowUnsafeBlocks>
 		<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
 		<Title>UnmanagedMemoryUtils</Title>
-		<VersionPrefix>1.0.6</VersionPrefix>
+		<VersionPrefix>1.1.0</VersionPrefix>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<Description>A .NET collection of utilities for working with unmanaged memory.
 Provides faster alternatives to Memory&lt;T&gt; and ReadOnlyMemory&lt;T&gt; in addition to accessing unmanaged string from managed code.
@@ -38,8 +38,14 @@ Version 1.0.5
 
 Version 1.0.6
 
-* Readme update with Nuget link.</PackageReleaseNotes>
-	</PropertyGroup>
+* Readme update with Nuget link.
+
+### Version 1.1.0
+
+* Update to .NET 8
+* Adds a new IUnsafeDisposable interface which offers an unsafe but less performance impacting to the standard IDisposable and finalizer pattern.
+* This interface is now implemented by IUnmanagedString and is available to use outside the library.</PackageReleaseNotes>
+</PropertyGroup>
 	<ItemGroup>
 		<None Include="..\..\README.md" Pack="true" PackagePath="\" />
 	</ItemGroup>