Struct RpcMiddlewareRequest 

pub struct RpcMiddlewareRequest {
    pub request_id: u64,
    pub raw_macaroon: Vec<u8>,
    pub custom_caveat_condition: String,
    pub msg_id: u64,
    pub metadata_pairs: HashMap<String, MetadataValues>,
    pub intercept_type: Option<InterceptType>,
}

Fields

request_id: u64

The unique ID of the intercepted original gRPC request. Useful for mapping request to response when implementing full duplex message interception. For streaming requests, this will be the same ID for all incoming and outgoing middleware intercept messages of the same stream.

raw_macaroon: Vec<u8>

The raw bytes of the complete macaroon as sent by the gRPC client in the original request. This might be empty for a request that doesn’t require macaroons such as the wallet unlocker RPCs.

custom_caveat_condition: String

The parsed condition of the macaroon’s custom caveat for convenient access. This field only contains the value of the custom caveat that the handling middleware has registered itself for. The condition must be validated for messages of intercept_type stream_auth and request!

msg_id: u64

The unique message ID of this middleware intercept message. There can be multiple middleware intercept messages per single gRPC request (one for the incoming request and one for the outgoing response) or gRPC stream (one for each incoming message and one for each outgoing response). This message ID must be referenced when responding (accepting/rejecting/modifying) to an intercept message.

metadata_pairs: HashMap<String, MetadataValues>

The metadata pairs that were sent along with the original gRPC request via the golang context.Context using explicit gRPC metadata. Context values are not propagated via gRPC and so we send any pairs along explicitly here so that the interceptor can access them.

intercept_type: Option<InterceptType>

There are three types of messages that will be sent to the middleware for inspection and approval: Stream authentication, request and response interception. The first two can only be accepted (=forward to main RPC server) or denied (=return error to client). Intercepted responses can also be replaced/overwritten.

Trait Implementations

impl Clone for RpcMiddlewareRequest

fn clone(&self) -> RpcMiddlewareRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RpcMiddlewareRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RpcMiddlewareRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for RpcMiddlewareRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RpcMiddlewareRequest

fn eq(&self, other: &RpcMiddlewareRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RpcMiddlewareRequest