Results

SLR.Results is a .NET library that is designed to tackle a common issue. It presents an object that reflects the success or failure of an operation, as opposed to utilizing or raising exceptions.

You can install SLR.Results with NuGet:

Install-Package SLR.Results

Key Features

• Works in most .NET Projects
• Choose from Result, Result, ListResult to cater for all use cases
• Store multiple errors or validation errors in one Result object
• Store Error or Success objects instead of only error messages in string format
• Allows uniformity in your code or anyone that needs to consume it
• ApiResponseHelper to have uniform API Responses in Controllers
• ListResult has built-in capability for paging using PagingExtensions

Return a Result

A Result can store multiple Errors, NotFound or ValidationErrors.

// return a result which indicates success
return Result.Success();

// return a result of a type which indicates success
return Result<Sample>.Success(new Sample());

//return a list result which indicates success
var entities = this.DatabaseContext.Samples.Select(x => x).AsNoTracking()
var count = await entities.Count();
var paged = await entities.ApplyPaging(model.PagingArgs).ToListAsync(cancellationToken);

return ListResult<Sample>.Success(paged, count);

// return a result which indicates failure
return Result.Failure("Error");
return Result<Sample>.Failure("Error");

Result on the API

This will handle 400, 404, 500 and 200

  return ApiResponseHelper.ResponseOutcome(await this.Mediator.Send(new ExampleQuery(), cancellationToken), this)

.NET Targeting

.NET 6.0, .NET 7.0 and .NET 8.0

Contributors

Thanks to all the contributors and to all the people who gave feedback!

Copyright

Copyright (c) Stian Le Roux. See LICENSE for details.