Skip to content

Commit

Permalink
Merge pull request #35 from ipfs-shipyard/rel/0.6.0
Browse files Browse the repository at this point in the history
Release 0.6.0. Added missing IMfsApi.ReadFileStreamAsync method.
  • Loading branch information
Arlodotexe authored Apr 27, 2024
2 parents ef7d5dc + 8e1b48e commit f829aff
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
17 changes: 17 additions & 0 deletions src/CoreApi/IMfsApi.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 5 additions & 1 deletion src/IpfsCore.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand All @@ -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.
Expand Down

0 comments on commit f829aff

Please sign in to comment.