Updating to newest release

Author: LinkDotNet Bot

.github/workflows/codeql.yml

@@ -22,7 +22,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/[email protected].0
+        uses: actions/[email protected].1
 
       - uses: actions/[email protected]
         with:

.github/workflows/create-release.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
 
     - name: Checkout repository
-      uses: actions/[email protected].0
+      uses: actions/[email protected].1
       with:
         token: ${{ secrets.SBPAT }}
         persist-credentials: true

.github/workflows/docs.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: windows-latest
 
     steps:
-    - uses: actions/[email protected].0
+    - uses: actions/[email protected].1
 
     - name: Setup .NET
       uses: actions/[email protected]

.github/workflows/dotnet.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/[email protected].0
+    - uses: actions/[email protected].1
     - name: Setup .NET
       uses: actions/[email protected]
       with:

.github/workflows/update-release.yml

@@ -13,7 +13,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/[email protected].0
+      uses: actions/[email protected].1
       with:
         token: ${{ secrets.SBPAT }}
         persist-credentials: false

CHANGELOG.md

@@ -6,6 +6,13 @@ All notable changes to **ValueStringBuilder** will be documented in this file. T
 
 ## [Unreleased]
 
+## [1.18.5] - 2023-10-19
+
+### Changed
+
+-   Fixed a bug, where in `Append` overflows the internal buffer and throws an exception
+-   Use better struct layout to be more cache friendly
+
 ## [1.18.4] - 2023-10-14
 
 ### Changed
@@ -367,7 +374,9 @@ This release brings extensions to the `ValueStringBuilder` API. For `v1.0` the `
 
 -   Initial release
 
-[Unreleased]: https://github.com/linkdotnet/StringBuilder/compare/1.18.4...HEAD
+[Unreleased]: https://github.com/linkdotnet/StringBuilder/compare/1.18.5...HEAD
+
+[1.18.5]: https://github.com/linkdotnet/StringBuilder/compare/1.18.4...1.18.5
 
 [1.18.4]: https://github.com/linkdotnet/StringBuilder/compare/1.18.3...1.18.4
 

src/LinkDotNet.StringBuilder/ValueStringBuilder.Append.cs

@@ -14,9 +14,10 @@ public void Append(bool value)
     {
         // 5 is the length of the string "False"
         // So we can check if we have enough space in the buffer
-        if (bufferPosition + 5 > buffer.Length)
+        var newSize = bufferPosition + 5;
+        if (newSize > buffer.Length)
         {
-            Grow(bufferPosition);
+            Grow(newSize);
         }
 
         if (!value.TryFormat(buffer[bufferPosition..], out var charsWritten))
@@ -105,9 +106,10 @@ public void AppendLine(scoped ReadOnlySpan<char> str)
     private void AppendSpanFormattable<T>(T value, ReadOnlySpan<char> format = default, int bufferSize = 36)
         where T : ISpanFormattable
     {
-        if (bufferSize + bufferPosition >= Capacity)
+        var newSize = bufferSize + bufferPosition;
+        if (newSize >= Capacity)
         {
-            Grow(bufferSize + bufferPosition);
+            Grow(newSize);
         }
 
         if (!value.TryFormat(buffer[bufferPosition..], out var written, format, null))

src/LinkDotNet.StringBuilder/ValueStringBuilder.Enumerator.cs

@@ -11,23 +11,23 @@ public ref partial struct ValueStringBuilder
     [StructLayout(LayoutKind.Auto)]
     public ref struct Enumerator
     {
-        private readonly Span<char> span;
+        private readonly ReadOnlySpan<char> span;
         private int index;
 
         /// <summary>Initializes a new instance of the <see cref="Enumerator"/> struct.</summary>
         /// <param name="span">The span to enumerate.</param>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal Enumerator(Span<char> span)
+        internal Enumerator(ReadOnlySpan<char> span)
         {
             this.span = span;
             index = -1;
         }
 
         /// <summary>Gets the element at the current position of the enumerator.</summary>
-        public readonly ref char Current
+        public readonly char Current
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
-            get => ref span[index];
+            get => span[index];
         }
 
         /// <summary>Advances the enumerator to the next element of the span.</summary>

src/LinkDotNet.StringBuilder/ValueStringBuilder.cs

@@ -11,7 +11,7 @@ namespace LinkDotNet.StringBuilder;
 /// The <see cref="ValueStringBuilder"/> is declared as ref struct which brings certain limitations with it.
 /// You can only use it in another ref struct or as a local variable.
 /// </remarks>
-[StructLayout(LayoutKind.Auto)]
+[StructLayout(LayoutKind.Sequential)]
 [SkipLocalsInit]
 public ref partial struct ValueStringBuilder
 {

tests/LinkDotNet.StringBuilder.Benchmarks/AppendValueTypesBenchmark.cs

@@ -8,7 +8,7 @@ public class AppendValueTypes
     private const int NumberOfIterations = 25;
 
     [Benchmark]
-    public string DotNetStringBuilder()
+    public string DotNetStringBuilderAppendValue()
     {
         var builder = new System.Text.StringBuilder();
 
@@ -24,4 +24,22 @@ public string DotNetStringBuilder()
 
         return builder.ToString();
     }
+
+    [Benchmark]
+    public string ValueStringBuilderAppendValue()
+    {
+        using var builder = new ValueStringBuilder();
+
+        for (var i = 0; i < NumberOfIterations; i++)
+        {
+            builder.Append(true);
+            builder.Append(int.MaxValue);
+            builder.Append(decimal.MaxValue);
+            builder.Append(byte.MinValue);
+            builder.Append(float.Epsilon);
+            builder.Append(double.Epsilon);
+        }
+
+        return builder.ToString();
+    }
 }