GrpcRichError 0.1.3

.NET Standard 2.0 .NET Framework 4.6.1
dotnet add package GrpcRichError --version 0.1.3
NuGet\Install-Package GrpcRichError -Version 0.1.3
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="GrpcRichError" Version="0.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GrpcRichError --version 0.1.3
#r "nuget: GrpcRichError, 0.1.3"
#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 GrpcRichError as a Cake Addin
#addin nuget:?package=GrpcRichError&version=0.1.3

// Install GrpcRichError as a Cake Tool
#tool nuget:?package=GrpcRichError&version=0.1.3

gRPC Rich Error

Build NuGet API documentation
Adds support for the richer gRPC error model to gRPC for .NET via extension methods.

Usage

Add a reference to the GrpcRichError package to your project and use the namespace:

using GrpcRichError;

To throw an RPC exception with a rich error details:

throw new Google.Rpc.Status
{
    Code = (int)StatusCode.NotFound,
    Message = "some message",
    Details =
    {
        new ErrorInfo
        {
            Domain = "example.com",
            Reason = "some reason"
        },
        new BadRequest
        {
            // ...
        }
    }
}.ToException();

To extract rich error details from an RPC exception:

try
{
    // ...
}
catch (RpcException ex)
{
    var info = ex.GetDetail<ErrorInfo>();
    if (info != null)
    {
        // ...
    }
}

Building

The source code is in src/, config for building the API documentation is in doc/ and generated build artifacts are placed in artifacts/. The source code does not contain version numbers. Instead the version is determined during CI using GitVersion.

To build run .\build.ps1 or ./build.sh (.NET SDK is automatically downloaded if missing using 0install).

Contributing

We welcome contributions to this project such as bug reports, recommendations and pull requests.

This repository contains an EditorConfig file. Please make sure to use an editor that supports it to ensure consistent code style, file encoding, etc.. For full tooling support for all style and naming conventions consider using JetBrains' ReSharper or Rider products.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on GrpcRichError:

Package Downloads
Arc4u.Standard.gRPC

Core Framework to use gRPC.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.1.3 2,098 11/28/2022
0.1.2 47,065 8/6/2021
0.1.1 12,840 11/3/2020
0.1.0 542 10/7/2020