FluentSortingDotNet 1.0.0-beta.2

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.8.1 This package targets .NET Framework 4.8.1. The package is compatible with this framework or higher.
Suggested Alternatives

FluentSortingDotNet 1.0.0-rc.3

This is a prerelease version of FluentSortingDotNet.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package FluentSortingDotNet --version 1.0.0-beta.2
                    


                    

                
NuGet\Install-Package FluentSortingDotNet -Version 1.0.0-beta.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="FluentSortingDotNet" Version="1.0.0-beta.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="FluentSortingDotNet" Version="1.0.0-beta.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="FluentSortingDotNet" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add FluentSortingDotNet --version 1.0.0-beta.2
                    


                    

                
#r "nuget: FluentSortingDotNet, 1.0.0-beta.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package FluentSortingDotNet@1.0.0-beta.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=FluentSortingDotNet&version=1.0.0-beta.2&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=FluentSortingDotNet&version=1.0.0-beta.2&prerelease
                    


                            Install as a Cake Tool

FluentSortingDotNet

Features

  • Parse sort parameters from a string in the format name,-age
    • A custom parser can be added by extending the SortParameterParser class or implementing the ISortParameterParser interface.
  • Sort an IQueryable<T> based on the parsed parameters
  • Handle invalid sort parameters

Extensibility

The codebase is intentionally not very extensible. This is because the library is in a early stage and I want to see how it is used before adding more features. If you have any suggestions, please open an issue.

Example

Entity

public record Person(string Name, int Age);

Sorter

using FluentSortingDotNet;
using FluentSortingDotNet.Parser;

public sealed class PersonSorter(ISortParameterParser parser) : Sorter<Person>(parser)
{
    protected override void Configure(SortBuilder<Person> builder)
    {
        // when no parameters are provided, sort by name descending
        builder.ForParameter(p => p.Name).Name("name").Default(SortDirection.Descending);

        builder.ForParameter(p => p.Age).Name("age");
    }
}

Usage

using FluentSortingDotNet;
using FluentSortingDotNet.Parser;

var parser = new DefaultSortParameterParser();
var sorter = new PersonSorter(parser);

IQueryable<Person> peopleQuery = ...;

SortResult result = sorter.Sort(ref peopleQuery, "name,-age");

if (result.IsSuccess)
{
    var orderedPeople = peopleQuery.ToList();
}
else 
{
    Console.WriteLine($"Invalid sort parameters: {string.Join(", ", result.InvalidSortParameters)}");
}

Dependency Injection

services.AddSingleton<ISortParameterParser, DefaultSortParameterParser>();
services.AddSingleton<PersonSorter>();

Performance

The library is designed to be fast and memory efficient. The area that is yet to be optimized is the reflection used to call all the OrderBy methods.

Benchmarks

See the benchmarks for more information. Take the benchmark results with a grain of salt, as they seem to be too good to be true.

Benchmark results

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.