A simple and lightweight implementation of a non-empty list in C#, inspired by Scala's List, that ensures a collection always has at least one item. This helps in reducing null-related bugs and ensures safe operations on collections with at least one element. Includes both mutable NonEmptyList and ImmutableNonEmptyList, functional programming operations (Map, FlatMap, Reduce, Fold, Zip), async extensions, and JSON serialization support.
Get Started
$ dotnet add package Masterly.NonEmptyListReadme
Masterly.NonEmptyList
A simple and lightweight implementation of a non-empty list in C#, inspired by Scala's List, that ensures a collection always has at least one item. This helps in reducing null-related bugs and ensures safe operations on collections with at least one element.
Give a Star on Github! :star:
If you like or are using this project please give it a star. Thanks!
Features
- Always contains at least one element.
- Provides
HeadandTailaccess for list traversal. - Supports indexing for element access.
- Basic list operations like
Add,Contains,Count, and more.
Installation
Install the Masterly.NonEmptyList NuGet Package.
Package Manager Console
Install-Package Masterly.NonEmptyList
.NET Core CLI
dotnet add package Masterly.NonEmptyList
Usage
// Create a NonEmptyList with a single element
var nonEmptyList = new NonEmptyList<int>(1);
Console.WriteLine(nonEmptyList.Head); // Output: 1
// Create a NonEmptyList with multiple elements
var nonEmptyListMultiple = new NonEmptyList<int>(1, 2, 3);
Console.WriteLine(nonEmptyListMultiple.Head); // Output: 1
Console.WriteLine(nonEmptyListMultiple.Tail); // Output: NonEmptyList: [2, 3]
// Add an element to the list
nonEmptyListMultiple.Add(4);
Console.WriteLine(nonEmptyListMultiple); // Output: NonEmptyList: [1, 2, 3, 4]
// Access elements by index
Console.WriteLine(nonEmptyListMultiple[1]); // Output: 2
// Check if the list contains a specific element
Console.WriteLine(nonEmptyListMultiple.Contains(3)); // Output: True
License
MIT
Free Software, Hell Yeah!