Struct HttpUpgradeMitmRelayExtensions 

pub struct HttpUpgradeMitmRelayExtensions(pub Extensions);

Available on crate features http and std only.

Message-local metadata selected for an HTTP MITM upgrade.

Request matchers can insert this on the matched request to transfer values to the upgraded ingress stream. Response matchers and middleware can insert it on the response to transfer values to the upgraded egress stream. HttpUpgradeMitmRelay transfers these values only after both upgrades succeed, before calling the relay service. The relay reserves a shared response-local selection before returning the response, so outer response middleware can append values before the server completes the ingress upgrade. Use self_get_ref_or_insert(Self::default) to extend an existing selection instead of replacing its marker.

Only a message’s own marker is used: a response must not inherit the request’s selection through its extension parent chain. The payload should contain independently owned metadata, never the message’s extensions or its structural Ingress, Egress, or OnUpgrade state. In particular, snapshots of HTTP parts should have empty extensions to avoid ownership cycles and retaining resources from the HTTP exchange.

Selecting response metadata

To make response metadata available to the upgraded egress transport, insert it into this selection. Store it on the HTTP response as well when HTTP middleware needs access to the same value:

use rama_core::extensions::{Extension, ExtensionsRef};
use rama_http::{Response, layer::upgrade::mitm::HttpUpgradeMitmRelayExtensions};

#[derive(Debug, Clone, Extension)]
struct NegotiatedProtocol(&'static str);

let response = Response::new(());
let protocol = NegotiatedProtocol("chat");
// Keep the value on the HTTP response if HTTP middleware also needs it.
response.extensions().insert(protocol.clone());
// Append to the shared selection, including when an inner relay reserved it.
let selected = &response
    .extensions()
    .self_get_ref_or_insert(HttpUpgradeMitmRelayExtensions::default)
    .0;
selected.insert(protocol);

Use the same pattern on a matched request for ingress metadata. Always use the local lookup shown here so a response cannot reuse its request’s selection through the extension parent chain.

Tuple Fields

0: Extensions

Trait Implementations

impl Clone for HttpUpgradeMitmRelayExtensions

fn clone(&self) -> HttpUpgradeMitmRelayExtensions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpUpgradeMitmRelayExtensions

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

Formats the value using the given formatter.

impl Default for HttpUpgradeMitmRelayExtensions

fn default() -> HttpUpgradeMitmRelayExtensions

Returns the “default value” for a type.

impl Extension for HttpUpgradeMitmRelayExtensions