Ave.Extensions.Functional
0.1.0-preview.4
dotnet add package Ave.Extensions.Functional --version 0.1.0-preview.4
NuGet\Install-Package Ave.Extensions.Functional -Version 0.1.0-preview.4
<PackageReference Include="Ave.Extensions.Functional" Version="0.1.0-preview.4" />
<PackageVersion Include="Ave.Extensions.Functional" Version="0.1.0-preview.4" />
<PackageReference Include="Ave.Extensions.Functional" />
paket add Ave.Extensions.Functional --version 0.1.0-preview.4
#r "nuget: Ave.Extensions.Functional, 0.1.0-preview.4"
#:package Ave.Extensions.Functional@0.1.0-preview.4
#addin nuget:?package=Ave.Extensions.Functional&version=0.1.0-preview.4&prerelease
#tool nuget:?package=Ave.Extensions.Functional&version=0.1.0-preview.4&prerelease
Ave.Extensions.Functional
Functional programming extensions and utilities for .NET applications.
Features
- Maybe type (Option pattern) implementation
- Result type for error handling
- Fluent extension methods for functional composition
- FluentAssertions extensions for testing functional code
Packages
| Package | Description |
|---|---|
Ave.Extensions.Functional.Core |
Core functional types and utilities |
Ave.Extensions.Functional |
Extension methods for working with functional types |
Ave.Extensions.Functional.FluentAssertions |
FluentAssertions extensions for testing functional code |
Getting Started
Install the packages from NuGet:
dotnet add package Ave.Extensions.Functional
Basic usage:
using Ave.Extensions.Functional;
using Ave.Extensions.Functional.Core;
// Using the Maybe type
Maybe<string> maybeName = userName ?? Maybe<string>.None;
string greeting = maybeName
.OnSome(name => $"Hello, {name}!")
.OnNone(() => "Hello, guest!");
// Using the Result type
Result<User, Error> result = userService.GetUser(userId);
result
.OnSuccess(user => DisplayUser(user))
.OnFailure(error => DisplayError(error));
Maybe and null
Null and None are the same thing. Maybe.From(null), Maybe<T>.From(null) and an implicit
conversion from null all produce None, so a Maybe that reports HasValue never holds a null
value and Value is safe to use once HasValue has been checked. A Nullable<T> without a value
is treated as null and also yields None.
Only null yields None: default values such as 0, false and the empty string are values.
Maybe<string>.From(null).HasNoValue; // true
Maybe<string>.From(string.Empty).HasValue; // true
Maybe<int>.From(0).HasValue; // true
Mapping follows the same rule: if the mapping function returns null, OnSomeMap and OnNoneMap
produce None rather than a Maybe holding null.
Mapping a list: TraverseAll
TraverseAll applies a function that returns a Result to every item of a sequence. If every item
succeeds, you get all values, in input order. If one or more items fail, you get one error: the
combine function receives every error, in input order, and turns them into one.
Every item is visited, also after a failure. That is the difference with a loop that stops at the first error: a caller that validates a list hears about all problems at once.
Result<int, string> Parse(string text) =>
int.TryParse(text, out var number)
? Result<int, string>.Success(number)
: Result<int, string>.Failure($"'{text}' is not a number");
var ok = new[] { "3", "1", "2" }.TraverseAll(Parse, errors => string.Join("; ", errors));
// ok.Value: [3, 1, 2]
var bad = new[] { "a", "1", "b" }.TraverseAll(Parse, errors => string.Join("; ", errors));
// bad.Error: "'a' is not a number; 'b' is not a number"
- An empty sequence succeeds with an empty list.
combineis called only when something failed; a single failure arrives as a list of one.- The function may be asynchronous (
Func<T, Task<Result<TOut, E>>>). The items are then mapped one after the other, never in parallel. Ave.Extensions.ErrorPaths.Functionaladds an overload for itsErrortype that needs nocombine: it collects the errors withErrors.Aggregate.
Keeping earlier values: OnSuccessCombine
OnSuccessCombine works like OnSuccessBind: the next step runs only on success, and the first
error is returned unchanged. The difference is that the earlier values are kept. The success value
grows into a tuple, so a later step can use several earlier values without nesting:
Result<TrueTypeFont, string> ReadFont(string directory) =>
ReadHead(directory)
.OnSuccessCombine(head => ReadHhea(directory)) // Result<(Head, Hhea), string>
.OnSuccessCombine((head, hhea) => ReadMaxp(directory)) // Result<(Head, Hhea, Maxp), string>
.OnSuccessCombine((head, hhea, maxp) => ReadHmtx(directory, hhea.NumberOfHMetrics, maxp.GlyphCount))
.OnSuccessMap((head, hhea, maxp, hmtx) => new TrueTypeFont(head, hhea, maxp, hmtx));
- A chain holds up to 6 values.
- For a
Resultholding a tuple of 2 to 6 values,OnSuccessMap,OnSuccessBind,OnSuccessDoandMatchalso accept a function that takes the values as separate parameters, as in the last line above. A function with one parameter still receives the whole tuple. OnSuccessCombineand the tuple forms ofOnSuccessMap,OnSuccessBindandOnSuccessDohave the same asynchronous forms asOnSuccessBind: the source may be aTask<Result<…>>and the step may return aTask. The tuple form ofMatch, likeMatchitself, accepts aTask<Result<…>>.
Development
Building
cd libs/functional
dotnet build extensions.slnx
Running Tests
cd libs/functional
dotnet test extensions.slnx
License
MIT
| Product | Versions 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 was computed. 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 is compatible. 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 was computed. |
| 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. |
-
.NETStandard 2.0
- Ave.Extensions.Functional.Core (>= 0.1.0-preview.3)
-
net10.0
- Ave.Extensions.Functional.Core (>= 0.1.0-preview.3)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Ave.Extensions.Functional:
| Package | Downloads |
|---|---|
|
Ave.Extensions.FileSystem.Abstractions
Abstractions for file system operations across platforms. |
|
|
Ave.Extensions.Functional.FluentAssertions
FluentAssertions extensions for functional programming types |
|
|
Ave.Extensions.Documents.Core
Shared vocabulary of the Ave.Extensions.Documents engine: typed lengths, geometry, colour, source locations, semantic roles and the error-code tree. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.1.0-preview.4 | 46 | 11/18/2026 |
| 0.1.0-preview.3 | 166 | 11/15/2026 |
| 0.1.0-preview.2 | 87 | 10/10/2026 |
| 0.0.5-preview.1 | 919 | 5/3/2025 |
| 0.0.4-beta | 585 | 6/30/2023 |
| 0.0.2-beta | 260 | 12/24/2022 |