Struct ErrorDetailsPolicy 

pub struct ErrorDetailsPolicy { /* private fields */ }

Which routes return details in their error bodies.

A global switch plus per-route overrides, checked in the order they were added: the first whose pattern matches the route decides. A pattern is a glob over the mounted route path, where * stays within one segment and ** spans segments; every path parameter counts as one segment, so /v1/users/* matches the route /v1/users/{id}. Decided once per route when the router is built, so a request pays nothing for it.

Examples

use structured_proxy::transcode::error::ErrorDetailsPolicy;

// Details everywhere except the internal admin surface.
let policy = ErrorDetailsPolicy::default()
    .route("/v1/admin/**", false)
    .unwrap();
assert!(policy.enabled_for("/v1/users/{id}"));
assert!(!policy.enabled_for("/v1/admin/users/{id}"));

// Off by default, back on for one sub-route.
let policy = ErrorDetailsPolicy::disabled()
    .route("/v1/public/**", true)
    .unwrap();
assert!(!policy.enabled_for("/v1/users/{id}"));
assert!(policy.enabled_for("/v1/public/items"));

// The opaque-detail extension, off unless switched on, here for one route.
let policy = ErrorDetailsPolicy::default()
    .opaque_route("/v1/partner/**", true)
    .unwrap();
assert!(!policy.opaque_for("/v1/users/{id}"));
assert!(policy.opaque_for("/v1/partner/orders"));

Implementations

impl ErrorDetailsPolicy

pub fn disabled() -> Self

No details on any route, until a route switches them on.

pub fn route(self, pattern: &str, enabled: bool) -> Result<Self, String>

Add an override for the routes pattern matches, checked after the ones added before it.

Errors

A pattern that does not start with / (it could never match a route) or is not a valid glob.

pub fn with_opaque_details(self, enabled: bool) -> Self

Set, for every route without an override, whether a detail whose type no descriptor describes goes to opaqueDetails (see StatusDetails::with_opaque_details). Off by default: such bytes cannot be checked for a nested DebugInfo.

pub fn opaque_route(self, pattern: &str, enabled: bool) -> Result<Self, String>

Add an override of the opaque-detail extension for the routes pattern matches, checked after the ones added before it.

Errors

As route.

pub fn enabled_for(&self, route_path: &str) -> bool

Whether the route mounted at route_path (axum form, e.g. /v1/users/{id}) returns details: the first matching rule that sets it decides, otherwise the global switch.

pub fn opaque_for(&self, route_path: &str) -> bool

Whether the route mounted at route_path forwards details of unknown types in opaqueDetails: the first matching rule that sets it decides, otherwise the global switch.

Trait Implementations

impl Clone for ErrorDetailsPolicy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorDetailsPolicy

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

Formats the value using the given formatter.

impl Default for ErrorDetailsPolicy

fn default() -> Self

Details on every route, the opaque-detail extension off.