Skip to main content

RequestCtx

Struct RequestCtx 

Source
pub struct RequestCtx { /* private fields */ }
Expand description

Per-request context. Retains the full route handle and correlation id, provides interim stream emission, and exposes a cancellation signal.

Implementations§

Source§

impl RequestCtx

Source

pub fn module_handle(&self) -> ModuleHandle

Clone the connection’s control handle, for readiness and other module RPCs.

Source

pub fn request_payload(&self) -> Result<Option<(Value, &[u8])>, FramedBodyError>

Decodes a framed request only when ingress carried FLAG_BINARY. Call this only for management operations that declared operation_payload. Return a malformed body’s named error as a refusal before doing any work; the serve helper deliberately leaves that policy to the handler.

Source

pub fn route_handle(&self) -> RouteHandle

Full route handle retained from ingress.

Source

pub fn corr(&self) -> u64

Correlation id for this request.

Source

pub fn mark_binary_reply(&self)

Declare this request’s terminal HandlerOutcome::Response as raw bytes, not JSON, by setting FLAG_BINARY on its frame.

Mark a reply only when the operation’s contract defines a raw-byte reply, never for JSON contracts such as tool results or JSON management replies. The body is sent unchanged either way; the flag only declares that it is not JSON, and the daemon forwards it as is. The delivered frame is still bounded by subc_protocol::MAX_DELIVERED_FRAME_LEN, including its header.

All clones of this request’s context share the mark; other requests do not. It has no effect on errors, interim stream frames, or Streamed outcomes.

Source

pub async fn emit(&self, body: Vec<u8>) -> Result<(), SubcModuleError>

Emit an interim StreamData frame on this request’s (channel, corr). Once the request is cancelled or its route is gone, late emits are dropped.

Source

pub async fn emit_with_admission( &self, body: Vec<u8>, admission_class: Option<AdmissionClass>, ) -> Result<(), SubcModuleError>

Emit StreamData with an explicit admission class. None means NORMAL.

Source

pub fn cancelled(&self) -> WaitForCancellationFuture<'_> ⓘ

Completes when the other side sends Cancel for this request or the route is torn down.

Source

pub fn cancellation_token(&self) -> CancellationToken

Return a cloneable cancellation token for code that prefers token polling.

Trait Implementations§

Source§

impl Clone for RequestCtx

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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