feat: Builder can be used in foreach loops

Author: linkdotnet

CHANGELOG.md

@@ -6,6 +6,10 @@ All notable changes to **ValueStringBuilder** will be documented in this file. T
 
 ## [Unreleased]
 
+### Added
+
+- Added custom enumerator to `ValueStringBuilder` so it can be used in `foreach` loops
+
 ## [1.17.0] - 2023-04-13
 
 ### Added

src/LinkDotNet.StringBuilder/ValueStringBuilder.Enumerator.cs

@@ -0,0 +1,48 @@
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+
+namespace LinkDotNet.StringBuilder;
+
+public ref partial struct ValueStringBuilder
+{
+    public readonly Enumerator GetEnumerator() => new(buffer[..bufferPosition]);
+
+    /// <summary>Enumerates the elements of a <see cref="Span{T}"/>.</summary>
+    [StructLayout(LayoutKind.Auto)]
+    public ref struct Enumerator
+    {
+        private readonly Span<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)
+        {
+            this.span = span;
+            index = -1;
+        }
+
+        /// <summary>Gets the element at the current position of the enumerator.</summary>
+        public ref char Current
+        {
+            [MethodImpl(MethodImplOptions.AggressiveInlining)]
+            get => ref span[index];
+        }
+
+        /// <summary>Advances the enumerator to the next element of the span.</summary>
+        /// <returns>True if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the span.</returns>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public bool MoveNext()
+        {
+            var nextIndex = index + 1;
+            if (nextIndex < span.Length)
+            {
+                index = nextIndex;
+                return true;
+            }
+
+            return false;
+        }
+    }
+}

stylecop.analyzers.ruleset

@@ -9,6 +9,8 @@
         <Rule Id="CA1009" Action="Warning"/>
         <Rule Id="CA1016" Action="Warning"/>
         <Rule Id="CA1033" Action="Warning"/>
+        <Rule Id="CA1034" Action="None"/>
+        <Rule Id="CA1033" Action="Warning"/>
         <Rule Id="CA1049" Action="Warning"/>
         <Rule Id="CA1060" Action="Warning"/>
         <Rule Id="CA1061" Action="Warning"/>

tests/LinkDotNet.StringBuilder.UnitTests/ValueStringBuilderTests.cs

@@ -489,4 +489,18 @@ public void GivenAString_WhenCallingToStringWithRange_ThenShouldReturnSubstring(
 
         builder.ToString(1..4).Should().Be("ell");
     }
+
+    [Fact]
+    public void GivenAString_WhenEnumerating_ThenShouldReturnCharacters()
+    {
+        using var builder = new ValueStringBuilder("Hello World");
+        var output = string.Empty;
+
+        foreach (var c in builder)
+        {
+            output += c;
+        }
+
+        output.Should().Be("Hello World");
+    }
 }