using LinkDotNet.StringBuilder; // Namespace of the package
using ValueStringBuilder stringBuilder = new();
stringBuilder.AppendLine("Hello World");
string result = stringBuilder.ToString();
There are also smaller helper functions, which enable you to use ValueStringBuilder without any instance:
By default, ValueStringBuilder uses a rented buffer from ArrayPool<char>.Shared.
You can avoid renting overhead with an initially stack-allocated buffer:
using ValueStringBuilder stringBuilder = new(stackalloc char[128]);
Note that this will prevent you from returning stringBuilder or assigning it to an out parameter.
What does it solve?
The dotnet version of the StringBuilder is an all-purpose version that normally fits a wide variety of needs.
But sometimes, low allocation is key. Therefore I created the ValueStringBuilder. It is not a class but a ref struct that tries to allocate as little as possible.
If you want to know how the ValueStringBuilder works and why it uses allocations and is even faster, check out this blog post.
The blog goes into a bit more in detail about how it works with a simplistic version of the ValueStringBuilder.
What doesn't it solve?
The library is not meant as a general replacement for the StringBuilder built into .NET. You can head over to the documentation and read about the "Known limitations".
The library works best for a small to medium length strings (not hundreds of thousands of characters, even though it can be still faster and performs fewer allocations). At any time, you can convert the ValueStringBuilder to a "normal" StringBuilder and vice versa.
The normal use case is to concatenate strings in a hot path where the goal is to put as minimal pressure on the GC as possible.
Documentation
More detailed documentation can be found here. It is really important to understand how the ValueStringBuilder works so that you did not run into weird situations where performance/allocations can even rise.
Benchmark
The following table compares the built-in StringBuilder and this library's ValueStringBuilder:
