Skip to main content

UnaryRequest

Struct UnaryRequest 

Source
#[non_exhaustive]
pub struct UnaryRequest { pub ctx: RequestContext, pub payload: Payload, }
Expand description

A unary RPC request as seen by an Interceptor.

Carries the dispatch RequestContext (headers, deadline, extensions, Spec, negotiated protocol) and the lazily-decoded body. Both fields are public so an interceptor can rewrite headers (ctx.headers_mut()), inject extensions (ctx.extensions_mut()), or replace the message (payload.set_message(..)) and pass the mutated request to Next::run.

ctx.spec() is Some(..) for generated FooServiceServer<T> dispatchers and for Router routes registered through the generated register(); it is None only for low-level manual registrations without a Router::with_spec call.

#[non_exhaustive] so future fields can be added without a breaking change. Construct with UnaryRequest::new (from wire bytes) or UnaryRequest::from_parts (from a Payload); copy for a second attempt with UnaryRequest::try_clone; destructure with a trailing ...

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§ctx: RequestContext

The dispatch context. Changes made through headers_mut() or extensions_mut() before next.run propagate to the handler.

§payload: Payload

The lazily-decoded request body. Call set_message to replace it.

Implementations§

Source§

impl UnaryRequest

Source

pub fn new(ctx: RequestContext, body: Bytes, format: CodecFormat) -> Self

Build a UnaryRequest from a dispatch context and wire-encoded body. Used by the dispatch path and by test fixtures.

Source

pub fn from_parts(ctx: RequestContext, payload: Payload) -> Self

Build a UnaryRequest from a context and an existing Payload (the struct is #[non_exhaustive], so downstream code cannot use a struct literal) — e.g. around a typed message with Payload::from_message. Unlike new, does not apply the context’s decode limits to the payload; use new for untrusted wire bytes. For a retry copy, use try_clone, which keeps the limits.

Source

pub fn try_clone(&self) -> Result<Self, ConnectError>

Copy this request for another trip through the chain: clones the context and Payload::try_clones the body, so header edits on one attempt do not leak into another. See Next for the retry shape.

§Errors

Returns an error if the payload holds a replacement that fails to encode.

Trait Implementations§

Source§

impl Debug for UnaryRequest

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more