Merge pull request #35 from ipfs-shipyard/rel/0.6.0

Release 0.6.0. Added missing IMfsApi.ReadFileStreamAsync method.

Author: Arlodotexe

src/CoreApi/IMfsApi.cs

@@ -114,6 +114,23 @@ public interface IMfsApi
         /// </param>
         Task<string> ReadFileAsync(string path, long? offset = null, long? count = null, CancellationToken cancel = default);
 
+        /// <summary>
+        ///   Read a file as a stream from MFS.
+        /// </summary>
+        /// <param name="path">
+        ///   Path to file to be read. Required: yes
+        /// </param>
+        /// <param name="offset">
+        ///   Byte offset to begin reading from. Required: no
+        /// </param>
+        /// <param name="count">
+        ///   Maximum number of bytes to read. Required: no
+        /// </param>
+        /// <param name="cancel">
+        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
+        /// </param>
+        Task<Stream> ReadFileStreamAsync(string path, long? offset = null, long? count = null, CancellationToken cancel = default);
+
         /// <summary>
         ///   Remove a file or directory or from MFS.
         /// </summary>

src/IpfsCore.csproj

@@ -8,7 +8,7 @@
         <LangVersion>12.0</LangVersion>
 
         <!-- https://semver.org/spec/v2.0.0.html -->
-        <Version>0.5.0</Version>
+        <Version>0.6.0</Version>
         <AssemblyVersion>$(Version)</AssemblyVersion>
 
         <!-- Nuget specs -->
@@ -30,6 +30,10 @@
         <GeneratePackageOnBuild Condition=" '$(Configuration)' == 'Release' ">true</GeneratePackageOnBuild>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <PackageReleaseNotes>
+--- 0.6.0 ---
+[Breaking]
+Added missing IMfsApi.ReadFileStreamAsync method.
+
 --- 0.5.0 ---
 [Breaking]
 Added missing Name property to IFileSystemNode. This property was already present in the Ipfs.Http.FileSystemNode class, and is used in the MfsApi to get the name of the node. This is a breaking change, but it is unlikely that anyone has implemented this interface in their own code. If you have, you will need to add the Name property to your implementation.