SimpleResults

A lightweight implementation of the Result pattern for error handling without exceptions
git clone git://git.hanetzok.net/SimpleResults
Log | Files | Refs | README | LICENSE

README (1169B)


      1 SimpleResults
      2 =============
      3 A lightweight .NET library implementing the Result pattern for elegant error handling without exceptions.
      4 
      5 Overview
      6 --------
      7 SimpleResults provides a type-safe way to handle operation outcomes in your 
      8 .NET applications. Instead of throwing exceptions for expected failures, 
      9 you can return Result objects that explicitly indicate success or failure 
     10 with detailed error information.
     11 
     12 Features
     13 --------
     14 - Result Pattern Implementation: Clean separation between success and failure paths
     15 - Type-Safe Error Handling: Avoid exception overhead for expected failures
     16 - Typed Results: Return values along with success/failure status
     17 - Detailed Error Information: Capture error codes, messages, and exceptions
     18 - Simple API: Easy-to-use factory methods for creating results
     19 
     20 
     21 Installation
     22 ------------
     23 Add the SimpleResults library to your project.
     24 
     25 Core Components
     26 ---------------
     27 - Result: Represents the outcome of an operation that doesn't return a value.
     28 - TypedResult<T>: Represents the outcome of an operation that returns a value of type T.
     29 - ErrorDetail: Encapsulates error information including error code, message, and optional exception.