Add some tweaks to SnappyStream (#113)

- Slightly more performant ReadByte/WriteByte overloads - Include DisposeAsync in test coverage Co-authored-by: Brant Burnett <[email protected]>
brantburnett · Dec 16, 2024 · f666781 · f666781
1 parent 3dee7b9
commit f666781
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,4 @@ Couchbase.snk
 BenchmarkDotNet.Artifacts/
 test-results/
 TestResults/
+.DS_Store
diff --git a/Snappier.Tests/SnappyStreamTests.cs b/Snappier.Tests/SnappyStreamTests.cs
@@ -60,6 +60,39 @@ public void CompressAndDecompress(string filename)
             Assert.Equal(sourceText, decompressedText);
         }
 
+        [Fact]
+        public void CompressAndDecompress_SingleByte()
+        {
+            using var resource =
+                typeof(SnappyStreamTests).Assembly.GetManifestResourceStream($"Snappier.Tests.TestData.alice29.txt");
+            Assert.NotNull(resource);
+
+            var inBuffer = new byte[128];
+            var readBytes = resource.Read(inBuffer, 0, inBuffer.Length);
+
+            using var output = new MemoryStream();
+
+            using (var compressor = new SnappyStream(output, CompressionMode.Compress, true))
+            {
+                for (var i = 0; i < readBytes; i++)
+                {
+                    compressor.WriteByte(inBuffer[i]);
+                }
+            }
+
+            output.Position = 0;
+
+            using var decompressor = new SnappyStream(output, CompressionMode.Decompress, true);
+
+            var outBuffer = new byte[128];
+            for (var i = 0; i < readBytes; i++)
+            {
+                outBuffer[i] = (byte)decompressor.ReadByte();
+            }
+
+            Assert.Equal(inBuffer, outBuffer);
+        }
+
         [Theory]
         [InlineData("alice29.txt")]
         [InlineData("asyoulik.txt")]
@@ -80,13 +113,19 @@ public async Task CompressAndDecompressAsync(string filename)
 
             using var output = new MemoryStream();
 
+#if NET6_0_OR_GREATER
+            await
+#endif
             using (var compressor = new SnappyStream(output, CompressionMode.Compress, true))
             {
                 await resource.CopyToAsync(compressor);
             }
 
             output.Position = 0;
 
+#if NET6_0_OR_GREATER
+            await
+#endif
             using var decompressor = new SnappyStream(output, CompressionMode.Decompress, true);
 
             using var streamReader = new StreamReader(decompressor, Encoding.UTF8);

diff --git a/Snappier/SnappyStream.cs b/Snappier/SnappyStream.cs
@@ -4,6 +4,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.IO.Compression;
+using System.Runtime.InteropServices;
 using System.Threading;
 using System.Threading.Tasks;
 using Snappier.Internal;
@@ -180,8 +181,18 @@ public override long Seek(long offset, SeekOrigin origin)
         public override int Read(byte[] buffer, int offset, int count) => ReadCore(buffer.AsSpan(offset, count));
 
         #if !NETSTANDARD2_0
+
         /// <inheritdoc />
         public override int Read(Span<byte> buffer) => ReadCore(buffer);
+
+        /// <inheritdoc />
+        public override int ReadByte()
+        {
+            byte b = 0;
+            int r = ReadCore(MemoryMarshal.CreateSpan(ref b, 1));
+            return r == 0 ? -1 : b;
+        }
+
         #endif
 
         private int ReadCore(Span<byte> buffer)
@@ -350,8 +361,13 @@ public override void Write(byte[] buffer, int offset, int count) =>
             WriteCore(buffer.AsSpan(offset, count));
 
         #if !NETSTANDARD2_0
+
         /// <inheritdoc />
         public override void Write(ReadOnlySpan<byte> buffer) => WriteCore(buffer);
+
+        /// <inheritdoc />
+        public override void WriteByte(byte value) => WriteCore(MemoryMarshal.CreateReadOnlySpan(ref value, 1));
+
         #endif
 
         private void WriteCore(ReadOnlySpan<byte> buffer)