userver: ugrpc::server::Result< Response > Class Template Reference
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ugrpc::server::Result< Response > Class Template Reference

#include <userver/ugrpc/server/result.hpp>

Detailed Description

template<typename Response>
class ugrpc::server::Result< Response >

Result type for service handlers (non server-streaming).

Provides a way to return one of:

  1. Response + grpc::Status::OK;
  2. error grpc::Status.

For server-streaming RPCs, see ugrpc::server::StreamingResult.

Definition at line 25 of file result.hpp.

Public Member Functions

 Result (Response &&response)
 Construct from Response, implies OK status.
 
 Result (grpc::Status &&status)
 Construct from grpc::Status, only error status is allowed.
 
 Result (const grpc::Status &status)
 Construct from grpc::Status, only error status is allowed.
 
bool IsSuccess () const
 
grpc::Status && ExtractErrorStatus ()
 
const grpc::Status & GetErrorStatus () const
 
Response && ExtractResponse ()
 
const Response & GetResponse () const
 

Constructor & Destructor Documentation

◆ Result() [1/3]

template<typename Response>
ugrpc::server::Result< Response >::Result ( Response && response)
inline

Construct from Response, implies OK status.

Definition at line 28 of file result.hpp.

◆ Result() [2/3]

template<typename Response>
ugrpc::server::Result< Response >::Result ( grpc::Status && status)
inline

Construct from grpc::Status, only error status is allowed.

Definition at line 31 of file result.hpp.

◆ Result() [3/3]

template<typename Response>
ugrpc::server::Result< Response >::Result ( const grpc::Status & status)
inline

Construct from grpc::Status, only error status is allowed.

Definition at line 36 of file result.hpp.

Member Function Documentation

◆ ExtractErrorStatus()

template<typename Response>
grpc::Status && ugrpc::server::Result< Response >::ExtractErrorStatus ( )
inline
Returns
the contained error status.
Precondition
IsSuccess() == false.

Definition at line 45 of file result.hpp.

◆ ExtractResponse()

template<typename Response>
Response && ugrpc::server::Result< Response >::ExtractResponse ( )
inline
Returns
the contained response.
Precondition
IsSuccess() == true.

Definition at line 59 of file result.hpp.

◆ GetErrorStatus()

template<typename Response>
const grpc::Status & ugrpc::server::Result< Response >::GetErrorStatus ( ) const
inline
Returns
the contained error status.
Precondition
IsSuccess() == false.

Definition at line 52 of file result.hpp.

◆ GetResponse()

template<typename Response>
const Response & ugrpc::server::Result< Response >::GetResponse ( ) const
inline
Returns
the contained error status.
Precondition
IsSuccess() == true.

Definition at line 66 of file result.hpp.

◆ IsSuccess()

template<typename Response>
bool ugrpc::server::Result< Response >::IsSuccess ( ) const
inline
Returns
true if the Result contains Response, as opposed to an error status.

Definition at line 41 of file result.hpp.

The documentation for this class was generated from the following file: