LinkDotNet.StringBuilder
1.5.0
See the version list below for details.
dotnet add package LinkDotNet.StringBuilder --version 1.5.0
NuGet\Install-Package LinkDotNet.StringBuilder -Version 1.5.0
<PackageReference Include="LinkDotNet.StringBuilder" Version="1.5.0" />
paket add LinkDotNet.StringBuilder --version 1.5.0
#r "nuget: LinkDotNet.StringBuilder, 1.5.0"
// Install LinkDotNet.StringBuilder as a Cake Addin #addin nuget:?package=LinkDotNet.StringBuilder&version=1.5.0 // Install LinkDotNet.StringBuilder as a Cake Tool #tool nuget:?package=LinkDotNet.StringBuilder&version=1.5.0
StringBuilder
A fast and low allocation StringBuilder for .NET.
Getting Started
Install the package:
PM> Install-Package LinkDotNet.StringBuilder
Afterwards use the package as follow:
using LinkDotNet.StringBuilder; // Namespace of the package
ValueStringBuilder stringBuilder = new ValueStringBuilder();
stringBuilder.AppendLine("Hello World");
string result = stringBuilder.ToString();
What does it solve?
The dotnet version of the StringBuilder
is a all purpose version which 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
which tries to do as less allocations as possible.
If you want to know how the ValueStringBuilder
works and why it uses allocations and is even faster, checkout this blog post.
The blog goes a bit more in detail how it works with a simplistic version of the ValueStringBuilder
.
What it doesn't solve!
The library is not meant as a general replacement for the StringBuilder
shipped with the .net framework itself. You can head over to the documentation and read about the "Known limitations".
The library works best for a small to medium amount of strings (not multiple 100'000 characters, even though it can be still faster and uses less allocations). At anytime you can convert the ValueStringBuilder
to a "normal" StringBuilder
and vice versa.
The normal use case is to add concatenate strings in a hot-path where the goal is to put as minimal pressure on the GC as possible.
Documentation
A more detailed documentation can be found here. It is really important to understand how the ValueStringBuilder
works so that you not run into weird situations where performance / allocations can even rise.
Benchmark
The following table gives you a small comparison between the StringBuilder
which is part of .NET, ZString
and the ValueStringBuilder
:
BenchmarkDotNet=v0.13.2, OS=macOS Monterey 12.6.1 (21G217) [Darwin 21.6.0]
Apple M1 Pro, 1 CPU, 10 logical and 10 physical cores
.NET SDK=7.0.100-rc.2.22477.23
[Host] : .NET 6.0.10 (6.0.1022.47605), Arm64 RyuJIT AdvSIMD
DefaultJob : .NET 6.0.10 (6.0.1022.47605), Arm64 RyuJIT AdvSIMD
| Method | Mean | Error | StdDev | Ratio | RatioSD | Gen0 | Allocated | Alloc Ratio |
|------------------------------- |-----------:|---------:|---------:|------:|--------:|--------:|----------:|------------:|
| DotNetStringBuilder | 227.3 ns | 1.31 ns | 1.22 ns | 1.00 | 0.00 | 0.7114 | 1488 B | 1.00 |
| ValueStringBuilder | 128.7 ns | 0.57 ns | 0.53 ns | 0.57 | 0.00 | 0.2677 | 560 B | 0.38 |
| ValueStringBuilderPreAllocated | 113.9 ns | 0.67 ns | 0.60 ns | 0.50 | 0.00 | 0.2677 | 560 B | 0.38 |
| ZStringBuilderUtf8 | 1,976.1 ns | 17.33 ns | 15.37 ns | 8.69 | 0.08 | 31.2500 | 66120 B | 44.44 |
| ZStringBuilderUtf16 | 1,888.2 ns | 18.50 ns | 16.40 ns | 8.30 | 0.09 | 31.2500 | 66120 B | 44.44 |
For more comparison check the documentation.
Another benchmark shows that this ValueStringBuilder
uses less memory when it comes to appending ValueTypes
such as int
, double
, ...
| Method | Mean | Error | StdDev | Gen 0 | Allocated |
|-------------------- |---------:|---------:|---------:|-------:|----------:|
| DotNetStringBuilder | 17.21 us | 0.622 us | 1.805 us | 1.5259 | 6 KB |
| ValueStringBuilder | 16.24 us | 0.496 us | 1.462 us | 0.3357 | 1 KB |
Checkout the Benchmark for more detailed comparison and setup.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on LinkDotNet.StringBuilder:
Package | Downloads |
---|---|
DccUtils.TypeFormatting
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.22.0 | 79 | 12/18/2024 |
1.21.1 | 936 | 11/8/2024 |
1.21.0 | 1,601 | 9/20/2024 |
1.20.0 | 9,244 | 5/2/2024 |
1.19.1 | 229 | 4/19/2024 |
1.19.0 | 5,554 | 3/2/2024 |
1.18.6 | 5,111 | 11/3/2023 |
1.18.5 | 2,394 | 10/19/2023 |
1.18.4 | 391 | 10/14/2023 |
1.18.3 | 4,051 | 9/22/2023 |
1.18.2 | 262 | 9/8/2023 |
1.18.1 | 36,328 | 8/10/2023 |
1.18.0 | 24,901 | 6/8/2023 |
1.17.0 | 3,277 | 4/13/2023 |
1.16.0 | 377 | 3/28/2023 |
1.15.0 | 227 | 3/26/2023 |
1.14.0 | 251 | 3/25/2023 |
1.13.1 | 321 | 3/17/2023 |
1.13.0 | 38,004 | 3/4/2023 |
1.12.2 | 297 | 2/21/2023 |
1.12.0 | 958 | 1/9/2023 |
1.11.5 | 342 | 1/9/2023 |
1.11.4 | 344 | 1/7/2023 |
1.11.3 | 339 | 1/3/2023 |
1.11.2 | 341 | 1/3/2023 |
1.11.1 | 356 | 1/1/2023 |
1.11.0 | 336 | 1/1/2023 |
1.10.6 | 336 | 12/30/2022 |
1.10.5 | 325 | 12/29/2022 |
1.10.4 | 365 | 12/27/2022 |
1.10.3 | 333 | 12/26/2022 |
1.10.2 | 373 | 12/16/2022 |
1.10.1 | 408 | 11/28/2022 |
1.10.0 | 392 | 11/20/2022 |
1.9.0 | 393 | 11/18/2022 |
1.8.0 | 385 | 11/15/2022 |
1.7.0 | 384 | 11/12/2022 |
1.6.2 | 398 | 11/11/2022 |
1.6.1 | 407 | 11/11/2022 |
1.6.0 | 375 | 11/10/2022 |
1.5.1 | 398 | 11/5/2022 |
1.5.0 | 385 | 11/5/2022 |
1.4.1 | 408 | 11/4/2022 |
1.4.0 | 489 | 10/11/2022 |
1.3.0 | 481 | 7/25/2022 |
1.2.0 | 541 | 4/20/2022 |
1.1.0 | 515 | 4/16/2022 |
1.0.1 | 481 | 4/13/2022 |
1.0.0 | 489 | 4/12/2022 |
0.9.5 | 476 | 4/10/2022 |
0.9.4 | 512 | 4/9/2022 |
0.9.3 | 486 | 4/9/2022 |
0.9.2 | 473 | 4/7/2022 |
0.9.1 | 474 | 4/6/2022 |
0.9.0 | 515 | 4/4/2022 |