Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mnie/resulttype
ResultType implementation in C#
https://github.com/mnie/resulttype
csharp functional-programming result-type
Last synced: 2 days ago
JSON representation
ResultType implementation in C#
- Host: GitHub
- URL: https://github.com/mnie/resulttype
- Owner: MNie
- License: mit
- Created: 2018-07-21T17:33:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-05T00:52:27.000Z (almost 4 years ago)
- Last Synced: 2024-09-29T13:07:15.636Z (about 1 month ago)
- Topics: csharp, functional-programming, result-type
- Language: C#
- Size: 52.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ResultType & ResultType.Validation
* NuGet Status
| | ResultType | ResultType.Validation |
|---|---|---|
| nuget | [](https://www.nuget.org/packages/MNie.ResultType) | [](https://www.nuget.org/packages/MNie.ResultType.Validation) |
* Build Status
[](https://travis-ci.org/MNie/ResultType)
# ResultType
ResultType implementation in C#
Could be downloaded from NuGet:
```Install-Package MNie.ResultType```
Simple usage:
* without value
```csharp
var result = ResultFactory.CreateSuccess();
var error = ResultFactory.CreateFailure();
```
* with value
```csharp
var result = ResultFactory.CreateSuccess(true);
var error = ResultFactory.CreateFailure("error message");
```
* chaining results
```csharp
var result = ResultFactory.CreateSuccess()
.Bind(fromPreviousSuccess => ResultFactory.CreateSuccess(true));
```
```csharp
var result = ResultFactory.CreateSuccess()
.Bind(() => ResultFactory.CreateSuccess(true));
```
```csharp
var result = ResultFactory.CreateSuccess()
.Bind((fromPreviousSuccess, fromPreviousFailure) => ResultFactory.CreateSuccess(true));
```
* mapping result
```csharp
[HttpGet]
public IActionResult SomeAction() =>
"test".ToSuccess().Map(Ok, BadRequest);
```
`Bind` function accepts `Func` or `Func` it depends on you if you want to based on the previous value. There is also an async implementation of `Bind` with `Async` postfix.
There are also async functions which in fact are boxing result into a Task.
```csharp
ResultFactory.CreateSuccessAsync
ResultFactory.CreateFailureAsync
```
# ResultType.Validation
[ResultType.Validation](https://www.nuget.org/packages/MNie.ResultType.Validation/) package provides a simple Rule class to defines Rules which should apply to some objects and as a result returns ResultType.
Could be downloaded from NuGet:
```Install-Package MNie.ResultType.Validation```
example usage looks like this:
```csharp
var rules = new[]
{
new Rule(() => "name".StartsWith("n"), "name"),
new Rule(() => "dd".StartsWith("e"), "dd"),
new Rule(() => "hh".StartsWith("a"), "hh"),
new Rule(() => "hehe".StartsWith("h"), "hehe"),
};
var result = rules.Apply();
```
Besides `Rule` class package provides also a `RuleBuilder` class. By which you could define predicates based on which Success or Failure would be created.
Sample usage:
```csharp
class TestObject
{
public readonly string FieldA;
public readonly int FieldB;
public TestObject(string fieldA, int fieldB)
{
FieldA = fieldA;
FieldB = fieldB;
}
}
...
var result = RuleBuilder
.Build(() => new TestObject("", 5))
.For(x => x.FieldB, x => x > 10, "greater than 10")
.For(x => x.FieldB, x => x < 2, "less than 2")
.Apply();
```