IResult 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package IResult --version 1.0.0                
NuGet\Install-Package IResult -Version 1.0.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="IResult" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add IResult --version 1.0.0                
#r "nuget: IResult, 1.0.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 IResult as a Cake Addin
#addin nuget:?package=IResult&version=1.0.0

// Install IResult as a Cake Tool
#tool nuget:?package=IResult&version=1.0.0                

IResult

Simple set of generic structures when simple success?->message->data information is required.

Interfaces

There are two main interfaces for returning results:
IResult:

        bool Success            
        string Message
        string[] DiagnosticData  //Not included when serialized into json representation. Just for debugging purposes

IResult<T>:

        // Same structure as IResult, but including the following property
        T Object 

Helper Methods

And some methods for making easy and simplified response constructions
IResult

        IResult Error(Exception ex, params object[] optionalParams);

        IResult Error(string message, params object[] optionalParams);

        IResult Ok(string message);

        IResult Ok();

IResult<T>

        IResult<T> Error(Exception ex, params object[] optionalParams);

        IResult<T> Error(string message, params object[] optionalParams);

        IResult<T> Ok();

        IResult<T> Ok(string message);

        IResult<T> Ok(string message, T obj);

        IResult<T> Ok(T obj);

Quick Examples

Some examples:


        // simple result without any data
        IResult res = new Result().Ok();

        // simple error result
        IResult res = new Result().Error("Error test message");

        // typical exception handling pattern, with aditional data
        IResult<bool> res;
        ...
        catch (System.Exception ex)
        {
            object[] someData = new object[] { "uno", "dos", 3, 4.0, null };
            res = new Result<bool>().Error(ex, true, false, someData, "ultimo");
        }

Source Code

https://github.com/sergio-deluna/IResult

Product 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. 
.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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 565 9/2/2022
1.0.0 352 10/26/2021

Initial release