Struct RequestAuth 

#[non_exhaustive]
pub struct RequestAuth {
    pub placements: Vec<CredentialPlacement>,
    pub base_url: Option<String>,
    pub captured: BTreeMap<String, String>,
}

The per-request auth a provider contributes beyond a single Credential: zero or more CredentialPlacements plus an optional dynamic base-URL that overrides the connector’s configured one (captured from a login response — Bullhorn restUrl, Zoho region host, #511).

A connector that receives a non-is_empty RequestAuth uses it instead of the plain credential path for that request. #[non_exhaustive]: construct via RequestAuth::new and the builder methods so fields can be added as a minor change.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

placements: Vec<CredentialPlacement>

Credential placements to apply to the request.

base_url: Option<String>

Optional per-session base-URL override.

captured: BTreeMap<String, String>

Values captured by a multi-step login (name → value), exposed so a connector can substitute ${name} tokens into a raw request body (or header) string — an XML/SOAP gateway that must carry a captured sessionid inside its body, which no CredentialPlacement can express (#567). These are the same captured values the flow’s apply placements draw from; secret-bearing, so a connector must treat them as sensitive.

Implementations

impl RequestAuth

pub fn new() -> Self

An empty RequestAuth (no placements, no base-URL override).

pub fn with_placement(self, placement: CredentialPlacement) -> Self

Add a credential placement (builder).

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Set the dynamic base-URL override (builder).

pub fn with_captured(self, captured: BTreeMap<String, String>) -> Self

Attach the captured login values (name → value) for ${name} body/header substitution (builder, #567).

pub fn is_empty(&self) -> bool

True when the provider contributed nothing (the connector then falls back to the plain credential path).

Trait Implementations

impl Clone for RequestAuth

fn clone(&self) -> RequestAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestAuth

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

Formats the value using the given formatter.

impl Default for RequestAuth

fn default() -> RequestAuth

Returns the “default value” for a type.