MethodResultWrapper 3.0.6

Install-Package MethodResultWrapper -Version 3.0.6
dotnet add package MethodResultWrapper --version 3.0.6
<PackageReference Include="MethodResultWrapper" Version="3.0.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MethodResultWrapper --version 3.0.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MethodResultWrapper, 3.0.6"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install MethodResultWrapper as a Cake Addin
#addin nuget:?package=MethodResultWrapper&version=3.0.6

// Install MethodResultWrapper as a Cake Tool
#tool nuget:?package=MethodResultWrapper&version=3.0.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Method Result Wrapper by pvWay

Provides a generic wrapper that returns whether or not a method succeeded or failed carrying the method result on success or a list of notifications in case of failure. As of version 3.0.0 the package includes the DsoHttpResult<T> object that enables to standardize response from Web API. See interface here after. As of version 3.0.4 the pakcage can be used with the Oracle.LogWriter As of version 3.0.5 all methods also have an async overload As of version 3.0.6 you may add notifications to an existing result

Interfaces

MethodResult interfaces

    public interface IMethodResult
    {
        /// <summary>
        /// At least one notification has a severity
        /// greater or equal to Error
        /// </summary>
        bool Failure { get; }

        /// <summary>
        /// No notification or all notifications severity
        /// are lower than Error
        /// </summary>
        bool Success { get; }

        SeverityEnum Severity { get; }

        /// <summary>
        /// Bulk string made of the concatenation
        /// of the notifications separated by new
        /// lines
        /// </summary>
        string ErrorMessage { get; }

        IEnumerable<IMethodResultNotification> Notifications { get; }

        void AddNotification(string message, SeverityEnum severity);
        void AddNotification(IMethodResultNotification notification);

        /// <summary>
        /// Will throw new Exception(ErrorMessage)
        /// </summary>
        void Throw();
    }

    public interface IMethodResult<out T> : IMethodResult
    {
        T Data { get; }
    }

    public interface IMethodResultNotification
    {
        SeverityEnum Severity { get; }
        string Message { get; }
    }

ILoggerService interface

  • The ILoggerService provides both sync and async methods with serveral signatures including (1) simple message, (2) list of messages, (3) MethodResult object (see above) (4) Exception

  • Each log row is also qualified by a Severity level from Debug to Fatal and enables also some interesting meta data like (1) UserId, (2) CompanyId, (3) Topic (4) MachineName

  • The service will also capture MemberName, FilePath and LineNumber

  • Remark 1 : package pvWay.MsSqlLogWriterFw enables to persist the logs into an MSSql database

  • Remark 2 : package pvWay.OracleLogWriterFw enables to persist the logs into an Oracle database

Happy coding

NuGet packages (1)

Showing the top 1 NuGet packages that depend on MethodResultWrapper:

Package Downloads
MsSqlLoggerService

Ms Sql implementation of MethodResultWrapper ILoggerService. Persists logs into a MsSql table.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.6 120 9/22/2021
3.0.5 103 4/28/2021
3.0.4 104 4/27/2021
3.0.3 299 6/10/2020
3.0.2 187 6/10/2020
3.0.1 198 6/10/2020
3.0.0 213 6/10/2020
2.0.1 291 3/20/2020
2.0.0 248 3/19/2020
1.1.3 202 3/20/2020
1.1.2 298 3/19/2020
1.1.0 361 3/7/2020
1.0.0 218 2/28/2020

Now possible to add notifications