NOption 1.1.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package NOption --version 1.1.0
NuGet\Install-Package NOption -Version 1.1.0
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="NOption" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NOption --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: NOption, 1.1.0"
#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.
// Install NOption as a Cake Addin #addin nuget:?package=NOption&version=1.1.0 // Install NOption as a Cake Tool #tool nuget:?package=NOption&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
NOption
NOption is a concise and fluent implementation of the Option pattern for the .NET platform.
Usage
Add the library namespace
Simply import the NOption namespace:
import NOption;
Use Option<> as the return type
To start using NOption:
- Change your function return type to Option<>;
- The return value will implicitely be wrapped in an Option<>;
- To specify that there is no return value, use Option.None.
static Option<Color> GetFavoriteColor(string username)
{
if ("Emma".Equals(username))
{
return Color.Blue;
}
return Option.None;
}
Working with the result
To work with result, you can use Match (with named arguments to improve readability):
var result = GetFavoriteColor("Emma");
result.Match(
Some: (favoriteColor) => Console.WriteLine($"Emma likes the color {favoriteColor}."),
None: () => Console.WriteLine("Emma does not have a favorite color.")
);
// Print "Emma likes the color Blue"
You can also unwrap the content with a default value:
var result = GetFavoriteColor("Mark");
var favoriteColor = result.UnwrapOr(Color.Purple); // Returns Color.Purple
Or you can extract the value:
var result = GetFavoriteColor("Emma");
if (result.HasSome(out var favoriteColor))
{
Console.WriteLine($"Emma likes the color {favoriteColor}.")
}
Bonus
To rewrite GetFavoriteColor as a one line function, we could have use:
static Option<Color> GetFavoriteColor(string username)
{
return "Emma".Equals(username) ? Option.Some(Color.Blue) : Option.None;
}
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. |
.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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.