Struct TranscodeOptions 

pub struct TranscodeOptions { /* private fields */ }

How routes_with_options builds the transcoded routes.

Examples

use axum::http::HeaderName;
use structured_proxy::transcode::error::ErrorDetailsPolicy;
use structured_proxy::transcode::TranscodeOptions;

let options = TranscodeOptions::default()
    .with_error_details(ErrorDetailsPolicy::default().route("/v1/admin/**", false).unwrap())
    .with_ndjson_envelope(true)
    .with_denied_response_headers([HeaderName::from_static("x-debug-trace")]);

Implementations

impl TranscodeOptions

pub fn with_selection(self, selection: RpcSelection) -> Self

Transcode only the RPCs selection names (every annotated one by default).

pub fn with_error_details(self, policy: ErrorDetailsPolicy) -> Self

Which routes return google.rpc.Status details in their error bodies (all of them by default).

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

Wrap every NDJSON line of a server-streaming response in an envelope: {"result": <message>} for data, {"error": <error body>} for the terminal error (the grpc-gateway stream shape). Off by default, when a data line is the bare message and the error line carries an @type: google.rpc.Status marker instead. Only the envelope keeps the two apart for RPCs that stream google.protobuf.Any, Struct, Value or ListValue, whose messages can carry any keys. SSE is unaffected.

pub fn with_denied_response_headers( self, names: impl IntoIterator<Item = HeaderName>, ) -> Self

Response metadata keys that never become HTTP response headers, on top of gRPC’s own keys, hop-by-hop fields and x-http-code, which never do. Replaces any list set before. Use it to keep internal headers (debug traces, backend names) off a public edge; an upstream key not listed here reaches the client.

Trait Implementations

impl Clone for TranscodeOptions

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 TranscodeOptions

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

Formats the value using the given formatter.

impl Default for TranscodeOptions

fn default() -> Self

Returns the “default value” for a type.