Add support for encoding to stream async

Using a PipeWriter internally.

Author: Krusen

BencodeNET.Tests/Objects/BDictionaryTests.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.IO.Pipelines;
 using System.Linq;
 using System.Text;
@@ -424,5 +425,17 @@ public async Task WriteToPipeWriterAsync()
             var result = Encoding.UTF8.GetString(readResult.Buffer.First.Span.ToArray());
             result.Should().Be("d3:key5:valuee");
         }
+
+        [Fact]
+        public async Task WriteToStreamAsync()
+        {
+            var dict = new BDictionary { { "key", "value" } };
+
+            var stream = new MemoryStream();
+            await dict.EncodeToAsync(stream);
+
+            var result = Encoding.UTF8.GetString(stream.ToArray());
+            result.Should().Be("d3:key5:valuee");
+        }
     }
 }

BencodeNET.Tests/Objects/BListTests.cs

@@ -1,4 +1,5 @@
 using System;
+using System.IO;
 using System.IO.Pipelines;
 using System.Linq;
 using System.Text;
@@ -237,5 +238,17 @@ public async Task WriteToPipeWriterAsync()
             var result = Encoding.UTF8.GetString(readResult.Buffer.First.Span.ToArray());
             result.Should().Be("li1ei2e3:abce");
         }
+
+        [Fact]
+        public async Task WriteToStreamAsync()
+        {
+            var blist = new BList { 1, 2, "abc" };
+
+            var stream = new MemoryStream();
+            await blist.EncodeToAsync(stream);
+
+            var result = Encoding.UTF8.GetString(stream.ToArray());
+            result.Should().Be("li1ei2e3:abce");
+        }
     }
 }

BencodeNET.Tests/Objects/BNumberTests.cs

@@ -369,5 +369,17 @@ public async Task WriteToPipeWriterAsync()
             var result = Encoding.UTF8.GetString(readResult.Buffer.First.Span.ToArray());
             result.Should().Be("i1234e");
         }
+
+        [Fact]
+        public async Task WriteToStreamAsync()
+        {
+            var bnumber = new BNumber(1234);
+
+            var ms = new MemoryStream();
+            await bnumber.EncodeToAsync(ms);
+
+            var result = Encoding.UTF8.GetString(ms.ToArray());
+            result.Should().Be("i1234e");
+        }
     }
 }

BencodeNET.Tests/Objects/BStringTests.cs

@@ -309,5 +309,17 @@ public async Task WriteToPipeWriterAsync()
             var result = Encoding.UTF8.GetString(readResult.Buffer.First.Span.ToArray());
             result.Should().Be("21:æøå äö èéê ñ");
         }
+
+        [Fact]
+        public async Task WriteToStreamAsync()
+        {
+            var bstring = new BString("æøå äö èéê ñ");
+
+            var stream = new MemoryStream();
+            await bstring.EncodeToAsync(stream);
+
+            var result = Encoding.UTF8.GetString(stream.ToArray());
+            result.Should().Be("21:æøå äö èéê ñ");
+        }
     }
 }

BencodeNET/Objects/BObject.cs

@@ -52,6 +52,17 @@ public ValueTask<FlushResult> EncodeToAsync(PipeWriter writer, CancellationToken
             return EncodeObjectAsync(writer, cancellationToken);
         }
 
+        /// <summary>
+        /// Writes the object asynchronously as bencode to the specified <see cref="Stream"/> using a <see cref="PipeWriter"/>.
+        /// </summary>
+        /// <param name="stream">The stream to write to.</param>
+        /// <param name="writerOptions">The options for the <see cref="PipeWriter"/>.</param>
+        /// <param name="cancellationToken"></param>
+        public ValueTask<FlushResult> EncodeToAsync(Stream stream, StreamPipeWriterOptions writerOptions = null, CancellationToken cancellationToken = default)
+        {
+            return EncodeObjectAsync(PipeWriter.Create(stream, writerOptions), cancellationToken);
+        }
+
         /// <summary>
         /// Implementations of this method should encode their
         /// underlying value to bencode and write it to the stream.

BencodeNET/Objects/IBObject.cs

@@ -36,5 +36,13 @@ public interface IBObject
         /// <param name="writer">The writer to write to.</param>
         /// <param name="cancellationToken"></param>
         ValueTask<FlushResult> EncodeToAsync(PipeWriter writer, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Writes the object asynchronously as bencode to the specified <see cref="Stream"/> using a <see cref="PipeWriter"/>.
+        /// </summary>
+        /// <param name="stream">The stream to write to.</param>
+        /// <param name="writerOptions">The options for the <see cref="PipeWriter"/>.</param>
+        /// <param name="cancellationToken"></param>
+        ValueTask<FlushResult> EncodeToAsync(Stream stream, StreamPipeWriterOptions writerOptions = null, CancellationToken cancellationToken = default);
     }
 }