Struct ResolvedRoute 

pub struct ResolvedRoute { /* private fields */ }

A resolved op: the binding’s route and path_params.

Implementations

impl ResolvedRoute

pub fn new( route: impl Into<Cow<'static, str>>, path_params: Vec<String>, ) -> ResolvedRoute

route as the client binds it: the RPC op id (batch for /rpc/batch, subscribe/<op id> for a subscription), or the REST route template as the schema declares it, without the mount prefix. path_params in the order they are bound.

pub fn with_contract_key( self, key: impl Into<Cow<'static, str>>, ) -> ResolvedRoute

The op whose contract digest this route is bound under, when the route a custom resolver binds (a versioned /v1/... path, say) is not itself the op’s key: the RPC op_id, or "<METHOD> <template>" on REST, as the generated ACCEPTED_CONTRACTS spells it. Without it the layer looks the route up as given (the op id, or the method and template), and a route with no row is a 500 for a signed request: the layer cannot tell which shape the request was signed under.

pub fn contract_key(&self) -> Option<&str>

The key set by with_contract_key.

pub fn route(&self) -> &str

The route.

pub fn path_params(&self) -> &[String]

The path parameter values.

pub fn op(&self) -> &str

The op an super::EnvelopePolicy is asked about: the route, or for a subscription the bare op id after subscribe/ (decision B1).

pub fn is_subscription(&self) -> bool

Bound as subscribe/<op id>: an RPC subscription, which streams and so can never answer a signed request (the layer refuses it with a sealed 406 before the handler runs).

pub fn is_batch(&self) -> bool

Bound as batch: the whole /rpc/batch call (decision D11), whose frames the layer reads to apply the policy to each (B1). No REST template (they start with /) and no unary op id (the RPC resolver never binds one without a ., B2) can be batch.

impl ResolvedRoute

pub fn with_payload_types( self, request: &'static [&'static str], response: &'static [&'static str], ) -> ResolvedRoute

The payload types this route accepts and answers in, narrowing what the layer allows (EnvelopeLayerBuilder::payload_media_types) for this route alone: an op’s allowed set is the layer’s set intersected with this one. The built-in resolvers fill it from the schema’s capabilities.request_types / response_types; a custom resolver that sets none does not narrow.

use cratestack_axum::envelope_layer::ResolvedRoute;

let route = ResolvedRoute::new("/v1/charges", vec![]).with_payload_types(
    &["application/x-www-form-urlencoded"],
    &["application/json"],
);
assert_eq!(
    route.payload_request_types(),
    Some(&["application/x-www-form-urlencoded"][..])
);
assert_eq!(route.payload_response_types(), Some(&["application/json"][..]));
assert_eq!(ResolvedRoute::new("/v1/charges", vec![]).payload_request_types(), None);

pub fn payload_request_types(&self) -> Option<&'static [&'static str]>

The request types set by with_payload_types.

pub fn payload_response_types(&self) -> Option<&'static [&'static str]>

The response types set by with_payload_types.

Trait Implementations

impl Clone for ResolvedRoute

fn clone(&self) -> ResolvedRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResolvedRoute

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

Formats the value using the given formatter.

impl Eq for ResolvedRoute

impl PartialEq for ResolvedRoute

fn eq(&self, other: &ResolvedRoute) -> 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 ResolvedRoute