Corrected documentation and added Guid Insert

Author: linkdotnet

CHANGELOG.md

@@ -9,7 +9,7 @@ All notable changes to **ValueStringBuilder** will be documented in this file. T
 ### Added
 
 - `ToString(startIndex, length)` to get a substring from the builder
-- `Append(Guid guid)` as new overload
+- `Append(Guid guid)` and `Insert(Guid guid)` as new overload
 
 ## [1.6.2] - 2022-11-11
 

src/LinkDotNet.StringBuilder/ValueStringBuilder.Insert.cs

@@ -8,54 +8,54 @@ public ref partial struct ValueStringBuilder
     /// Insert the string representation of the boolean to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Boolean to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, bool value) => Insert(index, value.ToString());
 
     /// <summary>
     /// Insert the string representation of the char to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Character to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, char value) => InsertSpanFormattable(index, value);
 
     /// <summary>
     /// Insert the string representation of the signed byte to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Signed byte to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, sbyte value) => InsertSpanFormattable(index, value);
 
     /// <summary>
     /// Insert the string representation of the byte to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Byte to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, byte value) => InsertSpanFormattable(index, value);
 
     /// <summary>
     /// Insert the string representation of the short to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Short to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, short value) => InsertSpanFormattable(index, value);
 
     /// <summary>
     /// Insert the string representation of the integer to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Integer to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, int value) => InsertSpanFormattable(index, value);
 
     /// <summary>
     /// Insert the string representation of the long to the builder at the given index.
     /// </summary>
-    /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
+    /// <param name="index">Long where <paramref name="value"/> should be inserted.</param>
     /// <param name="value">String to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, long value) => InsertSpanFormattable(index, value);
@@ -64,26 +64,34 @@ public ref partial struct ValueStringBuilder
     /// Insert the string representation of the float to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Float to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, float value) => InsertSpanFormattable(index, value);
 
     /// <summary>
     /// Insert the string representation of the double to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Double to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, double value) => InsertSpanFormattable(index, value);
 
     /// <summary>
     /// Insert the string representation of the decimal to the builder at the given index.
     /// </summary>
     /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
-    /// <param name="value">String to insert into this builder.</param>
+    /// <param name="value">Decimal to insert into this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void Insert(int index, decimal value) => InsertSpanFormattable(index, value);
 
+    /// <summary>
+    /// Insert the string representation of the Guid to the builder at the given index.
+    /// </summary>
+    /// <param name="index">Index where <paramref name="value"/> should be inserted.</param>
+    /// <param name="value">Guid to insert into this builder.</param>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public void Insert(int index, Guid value) => InsertSpanFormattable(index, value);
+
     /// <summary>
     /// Appends the string representation of the boolean to the builder.
     /// </summary>
@@ -118,7 +126,7 @@ public void Insert(int index, scoped ReadOnlySpan<char> value)
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    private void InsertSpanFormattable<T>(int index, T value)
+    private void InsertSpanFormattable<T>(int index, T value, ReadOnlySpan<char> format = default)
         where T : ISpanFormattable
     {
         if (index < 0)
@@ -131,8 +139,8 @@ private void InsertSpanFormattable<T>(int index, T value)
             throw new ArgumentOutOfRangeException(nameof(index), "The given index can't be bigger than the string itself.");
         }
 
-        Span<char> tempBuffer = stackalloc char[24];
-        if (value.TryFormat(tempBuffer, out var written, default, null))
+        Span<char> tempBuffer = stackalloc char[36];
+        if (value.TryFormat(tempBuffer, out var written, format, null))
         {
             bufferPosition += written;
             if (bufferPosition > buffer.Length)

tests/LinkDotNet.StringBuilder.UnitTests/ValueStringBuilder.Insert.Tests.cs

@@ -206,4 +206,14 @@ public void ShouldThrowWhenIndexIsBehindBufferLengthForFormattableSpan()
 
         Assert.False(true);
     }
+
+    [Fact]
+    public void ShouldAppendGuid()
+    {
+        using var builder = new ValueStringBuilder();
+
+        builder.Insert(0, Guid.Empty);
+
+        builder.ToString().Should().Be("00000000-0000-0000-0000-000000000000");
+    }
 }