Updating to newest release

LinkDotNet Bot · LinkDotNet Bot · commit 734bf80d63a2 · 2025-10-30T06:56:55.000Z
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -22,13 +22,14 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
 
-      - uses: actions/setup-dotnet@v4.3.0
+      - uses: actions/setup-dotnet@v5.0.0
         with:
           dotnet-version: | 
             8.0.x
             9.0.x
+            10.0.x
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v3
diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
@@ -20,7 +20,7 @@ jobs:
     steps:
 
     - name: Checkout repository
-      uses: actions/checkout@v4.2.2
+      uses: actions/checkout@v5.0.0
       with:
         token: ${{ secrets.SBPAT }}
         persist-credentials: true
@@ -34,11 +34,12 @@ jobs:
         path: ./CHANGELOG.md
 
     - name: Setup dotnet
-      uses: actions/setup-dotnet@v4.3.0
+      uses: actions/setup-dotnet@v5.0.0
       with:
         dotnet-version: | 
           8.0.x
           9.0.x
+          10.0.x
 
     - name: Update CHANGELOG file
       uses: thomaseizinger/keep-a-changelog-new-release@3.1.0
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -12,17 +12,18 @@ jobs:
     runs-on: windows-latest
 
     steps:
-    - uses: actions/checkout@v4.2.2
+    - uses: actions/checkout@v5.0.0
 
     - name: Setup .NET
-      uses: actions/setup-dotnet@v4.3.0
+      uses: actions/setup-dotnet@v5.0.0
       with:
         dotnet-version: | 
           8.0.x
           9.0.x
+          10.0.x
 
     - name: Setup DocFX
-      uses: crazy-max/ghaction-chocolatey@v3.2.0
+      uses: crazy-max/ghaction-chocolatey@v3.4.0
       with:
         args: install docfx
 
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -12,13 +12,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4.2.2
+    - uses: actions/checkout@v5.0.0
     - name: Setup .NET
-      uses: actions/setup-dotnet@v4.3.0
+      uses: actions/setup-dotnet@v5.0.0
       with:
         dotnet-version: | 
           8.0.x
           9.0.x
+          10.0.x
           
     - name: Setup color
       run: |
diff --git a/.github/workflows/update-release.yml b/.github/workflows/update-release.yml
@@ -13,7 +13,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4.2.2
+      uses: actions/checkout@v5.0.0
       with:
         token: ${{ secrets.SBPAT }}
         persist-credentials: false
@@ -32,7 +32,7 @@ jobs:
         git merge --no-ff -X theirs origin/main -m "Updating to newest release"
         
     - name: Push changes
-      uses: ad-m/github-push-action@v0.8.0
+      uses: ad-m/github-push-action@v1.0.0
       with:
         github_token: ${{ secrets.SBPAT }}
         branch: stable
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,19 @@ All notable changes to **ValueStringBuilder** will be documented in this file. T
 
 ## [Unreleased]
 
+## [3.0.0] - 2025-10-30
+
+This is the `v3` major release. The API is almost the same as in `v2` - there is only a slight change in the `Concat` static helper method to reflect a less-boxed API.
+
+### Added
+
+- .NET 10.0 support
+- `IndexOf`, `LastIndexOf`, and `Contains` methods now support `StringComparison` 
+
+### Changed
+
+- `ValueStringBuilder.Concat` uses `params ReadOnlySpan<T>` to reduce boxing and improve performance.
+
 ## [2.4.1] - 2025-03-25
 
 ### Changed
@@ -496,7 +509,8 @@ This release brings extensions to the `ValueStringBuilder` API. For `v1.0` the `
 
 - Initial release
 
-[unreleased]: https://github.com/linkdotnet/StringBuilder/compare/2.4.1...HEAD
+[unreleased]: https://github.com/linkdotnet/StringBuilder/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/linkdotnet/StringBuilder/compare/2.4.1...3.0.0
 [2.4.1]: https://github.com/linkdotnet/StringBuilder/compare/2.4.0...2.4.1
 [2.4.0]: https://github.com/linkdotnet/StringBuilder/compare/2.3.1...2.4.0
 [2.3.1]: https://github.com/linkdotnet/StringBuilder/compare/2.3.0...2.3.1
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 	<ItemGroup>
-      <PackageReference Include="SonarAnalyzer.CSharp" Version="10.7.0.110445">
+      <PackageReference Include="SonarAnalyzer.CSharp" Version="10.9.0.115408">
         <PrivateAssets>all</PrivateAssets>
         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       </PackageReference>
diff --git a/docs/site/articles/known_limitations.md b/docs/site/articles/known_limitations.md
@@ -27,13 +27,6 @@ var greeting = stringBuilder
 
 This does not work with the `ValueStringBuilder`. The simple reason: `struct`s can't return `ref this`. If we don't return the reference then new allocations are introduced and can also lead to potential bugs/issues. Therefore it is a conscious design decision not to allow fluent notation.
 
-## IDisposable
-The `ValueStringBuilder` does not directly implement `IDisposable` as `ref struct`s are not allowed to do so (as they might get boxed in the process, which violates the rule of `ref struct`s). Still, the `using` statement can be used with the `ValueStringBuilder`. It is used to return rented memory from an array pool if any is taken.
-
-```csharp
-using var stringBuilder = new ValueStringBuilder();
-```
-
 There are scenarios, where you can elide the `using` keyword. Exactly then when you provide the buffer in the first place and you are **sure** that no internal growing has to be done. This should only be done if you can guarantee that.
 
 ```csharp
diff --git a/docs/site/index.md b/docs/site/index.md
@@ -9,7 +9,7 @@
 The library makes heavy use of `Span<T>`, `stackalloc` and `ArrayPool`s to achieve low allocations and fast performance.
 
 ## Download
-The package is hosted on [nuget.org]((https://www.nuget.org/packages/LinkDotNet.StringBuilder/)), so easily add the package reference:
+The package is hosted on [nuget.org](https://www.nuget.org/packages/LinkDotNet.StringBuilder/), so easily add the package reference:
 > PM> Install-Package LinkDotNet.StringBuilder
 
 Afterwards, you can simply use it. It tries to mimic the API of the `StringBuilder` to a certain extent so for simpler cases you can exchange those two.
diff --git a/src/LinkDotNet.StringBuilder/LinkDotNet.StringBuilder.csproj b/src/LinkDotNet.StringBuilder/LinkDotNet.StringBuilder.csproj
@@ -1,7 +1,7 @@
-﻿<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
+        <TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
@@ -36,13 +36,13 @@
     <PropertyGroup Label="Analyzer settings">
         <AnalysisMode>AllEnabledByDefault</AnalysisMode>
         <EnableNETAnalyzers>true</EnableNETAnalyzers>
-        <AnalysisLevel>8</AnalysisLevel>
+        <AnalysisLevel>latest</AnalysisLevel>
         <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="Meziantou.Analyzer" Version="2.0.189">
+      <PackageReference Include="Meziantou.Analyzer" Version="2.0.200">
         <PrivateAssets>all</PrivateAssets>
         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       </PackageReference>
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.Append.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.Append.cs
@@ -1,4 +1,4 @@
-﻿using System.Runtime.CompilerServices;
+using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 using System.Text;
 
@@ -54,7 +54,7 @@ public unsafe void Append(bool value)
     /// requires more space than the default (36 characters), adjust the value.</param>
     /// <typeparam name="T">Any <see cref="ISpanFormattable"/>.</typeparam>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    public void Append<T>(T value, ReadOnlySpan<char> format = default, int bufferSize = 36)
+    public void Append<T>(T value, scoped ReadOnlySpan<char> format = default, int bufferSize = 36)
         where T : ISpanFormattable => AppendSpanFormattable(value, format, bufferSize);
 
     /// <summary>
@@ -181,7 +181,7 @@ public Span<char> AppendSpan(int length)
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    private void AppendSpanFormattable<T>(T value, ReadOnlySpan<char> format = default, int bufferSize = 36)
+    private void AppendSpanFormattable<T>(T value, scoped ReadOnlySpan<char> format = default, int bufferSize = 36)
         where T : ISpanFormattable
     {
         var newSize = bufferSize + bufferPosition;
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.AppendFormat.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.AppendFormat.cs
@@ -17,7 +17,7 @@ public ref partial struct ValueStringBuilder
     /// </remarks>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendFormat<T>(
-        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] ReadOnlySpan<char> format,
+        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] scoped ReadOnlySpan<char> format,
         T arg)
     {
         var formatIndex = 0;
@@ -73,7 +73,7 @@ public void AppendFormat<T>(
     /// </remarks>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendFormat<T1, T2>(
-        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] ReadOnlySpan<char> format,
+        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] scoped ReadOnlySpan<char> format,
         T1 arg1,
         T2 arg2)
     {
@@ -141,7 +141,7 @@ public void AppendFormat<T1, T2>(
     /// </remarks>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendFormat<T1, T2, T3>(
-        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] ReadOnlySpan<char> format,
+        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] scoped ReadOnlySpan<char> format,
         T1 arg1,
         T2 arg2,
         T3 arg3)
@@ -215,7 +215,7 @@ public void AppendFormat<T1, T2, T3>(
     /// </remarks>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendFormat<T1, T2, T3, T4>(
-        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] ReadOnlySpan<char> format,
+        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] scoped ReadOnlySpan<char> format,
         T1 arg1,
         T2 arg2,
         T3 arg3,
@@ -295,7 +295,7 @@ public void AppendFormat<T1, T2, T3, T4>(
     /// </remarks>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendFormat<T1, T2, T3, T4, T5>(
-        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] ReadOnlySpan<char> format,
+        [StringSyntax(StringSyntaxAttribute.CompositeFormat)] scoped ReadOnlySpan<char> format,
         T1 arg1,
         T2 arg2,
         T3 arg3,
@@ -360,7 +360,7 @@ public void AppendFormat<T1, T2, T3, T4, T5>(
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    private static int GetValidArgumentIndex(ReadOnlySpan<char> placeholder, int allowedRange)
+    private static int GetValidArgumentIndex(scoped ReadOnlySpan<char> placeholder, int allowedRange)
     {
         if (!int.TryParse(placeholder[1..^1], null, out var argIndex))
         {
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.AppendJoin.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.AppendJoin.cs
@@ -14,6 +14,24 @@ public ref partial struct ValueStringBuilder
     public void AppendJoin(ReadOnlySpan<char> separator, IEnumerable<string?> values)
         => AppendJoinInternalString(separator, values);
 
+    /// <summary>
+    /// Concatenates and appends all values with the given separator between each entry at the end of the string.
+    /// </summary>
+    /// <param name="separator">String used as separator between the entries.</param>
+    /// <param name="values">Enumerable of strings to be concatenated.</param>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public void AppendJoin(ReadOnlySpan<char> separator, scoped ReadOnlySpan<string?> values)
+        => AppendJoinInternalString(separator, values);
+
+    /// <summary>
+    /// Concatenates and appends all values with the given separator between each entry at the end of the string.
+    /// </summary>
+    /// <param name="separator">Character used as separator between the entries.</param>
+    /// <param name="values">Enumerable of strings to be concatenated.</param>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public void AppendJoin(char separator, scoped ReadOnlySpan<string?> values)
+        => AppendJoinInternalChar(separator, values);
+
     /// <summary>
     /// Concatenates and appends all values with the given separator between each entry at the end of the string.
     /// </summary>
@@ -39,7 +57,17 @@ public void AppendJoin(Rune separator, IEnumerable<string?> values)
     /// <param name="values">Enumerable to be concatenated.</param>
     /// <typeparam name="T">Type of the given enumerable.</typeparam>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    public void AppendJoin<T>(ReadOnlySpan<char> separator, IEnumerable<T> values)
+    public void AppendJoin<T>(scoped ReadOnlySpan<char> separator, IEnumerable<T> values)
+        => AppendJoinInternalString(separator, values);
+
+    /// <summary>
+    /// Concatenates and appends all values with the given separator between each entry at the end of the string.
+    /// </summary>
+    /// <param name="separator">String used as separator between the entries.</param>
+    /// <param name="values">Enumerable to be concatenated.</param>
+    /// <typeparam name="T">Type of the given enumerable.</typeparam>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public void AppendJoin<T>(scoped ReadOnlySpan<char> separator, ReadOnlySpan<T> values)
         => AppendJoinInternalString(separator, values);
 
     /// <summary>
@@ -52,6 +80,16 @@ public void AppendJoin<T>(ReadOnlySpan<char> separator, IEnumerable<T> values)
     public void AppendJoin<T>(char separator, IEnumerable<T> values)
         => AppendJoinInternalChar(separator, values);
 
+    /// <summary>
+    /// Concatenates and appends all values with the given separator between each entry at the end of the string.
+    /// </summary>
+    /// <param name="separator">Character used as separator between the entries.</param>
+    /// <param name="values">Enumerable to be concatenated.</param>
+    /// <typeparam name="T">Type of the given enumerable.</typeparam>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public void AppendJoin<T>(char separator, scoped ReadOnlySpan<T> values)
+        => AppendJoinInternalChar(separator, values);
+
     /// <summary>
     /// Concatenates and appends all values with the given separator between each entry at the end of the string.
     /// </summary>
@@ -63,7 +101,7 @@ public void AppendJoin<T>(Rune separator, IEnumerable<T> values)
         => AppendJoinInternalRune(separator, values);
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    private void AppendJoinInternalString<T>(ReadOnlySpan<char> separator, IEnumerable<T> values)
+    private void AppendJoinInternalString<T>(scoped ReadOnlySpan<char> separator, IEnumerable<T> values)
     {
         ArgumentNullException.ThrowIfNull(values);
 
@@ -85,6 +123,23 @@ private void AppendJoinInternalString<T>(ReadOnlySpan<char> separator, IEnumerab
         }
     }
 
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    private void AppendJoinInternalString<T>(scoped ReadOnlySpan<char> separator, scoped ReadOnlySpan<T> values)
+    {
+        if (values.Length == 0)
+        {
+            return;
+        }
+
+        AppendInternal(values[0]);
+
+        for (var i = 1; i < values.Length; i++)
+        {
+            Append(separator);
+            AppendInternal(values[i]);
+        }
+    }
+
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     private void AppendJoinInternalChar<T>(char separator, IEnumerable<T> values)
     {
@@ -108,6 +163,23 @@ private void AppendJoinInternalChar<T>(char separator, IEnumerable<T> values)
         }
     }
 
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    private void AppendJoinInternalChar<T>(char separator, scoped ReadOnlySpan<T> values)
+    {
+        if (values.Length == 0)
+        {
+            return;
+        }
+
+        AppendInternal(values[0]);
+
+        for (var i = 1; i < values.Length; i++)
+        {
+            Append(separator);
+            AppendInternal(values[i]);
+        }
+    }
+
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     private void AppendJoinInternalRune<T>(Rune separator, IEnumerable<T> values)
     {
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.Concat.Helper.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.Concat.Helper.cs
@@ -11,9 +11,9 @@ public ref partial struct ValueStringBuilder
     /// <typeparam name="T">Any given type, which can be translated to <see cref="string"/>.</typeparam>
     /// <returns>Concatenated string or an empty string if <paramref name="values"/> is empty.</returns>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    public static string Concat<T>(params T[] values)
+    public static string Concat<T>(params scoped ReadOnlySpan<T> values)
     {
-        if (values is null || values.Length == 0)
+        if (values.Length == 0)
         {
             return string.Empty;
         }
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.Trim.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.Trim.cs
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.cs
diff --git a/tests/LinkDotNet.StringBuilder.UnitTests/LinkDotNet.StringBuilder.UnitTests.csproj b/tests/LinkDotNet.StringBuilder.UnitTests/LinkDotNet.StringBuilder.UnitTests.csproj
diff --git a/tests/LinkDotNet.StringBuilder.UnitTests/ValueStringBuilderTests.cs b/tests/LinkDotNet.StringBuilder.UnitTests/ValueStringBuilderTests.cs
