Struct WebServerFlowBuilder 

pub struct WebServerFlowBuilder { /* private fields */ }

Builder for WebServerFlow.

Implementations

impl WebServerFlowBuilder

pub fn consumer_key(self, key: impl Into<String>) -> Self

Connected App’s Consumer Key (Client ID). Required.

pub fn consumer_secret(self, secret: impl Into<String>) -> Self

Connected App’s Consumer Secret. Optional — set only for confidential clients. Public (PKCE-only) clients omit it.

pub fn redirect_uri(self, uri: impl Into<String>) -> Self

Redirect URI registered on the Connected App. Required. Must match exactly (Salesforce compares string-for-string).

pub fn login_url(self, url: impl Into<String>) -> Self

Authorization host. Defaults to PRODUCTION_LOGIN_URL. Use SANDBOX_LOGIN_URL for sandboxes or your org’s My Domain login URL.

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

Adds a scope to the authorization request. Multiple calls accumulate. Common values include api, refresh_token, id, openid.

pub fn scopes<I, S>(self, scopes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the entire scope set. Convenient when scopes are computed elsewhere as a slice.

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

Adds the OAuth prompt parameter (e.g. login, consent, select_account).

pub fn login_hint(self, hint: impl Into<String>) -> Self

Pre-fills the username field on the authorization page.

pub fn build(self) -> AuthResult<WebServerFlow>

Finalizes the builder.

Trait Implementations

impl Debug for WebServerFlowBuilder

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

Formats the value using the given formatter.

impl Default for WebServerFlowBuilder

fn default() -> WebServerFlowBuilder

Returns the “default value” for a type.