Struct OAuthProvider 

pub struct OAuthProvider { /* private fields */ }

Builder-like representation of an OAuth identity provider.

The provider stores configuration (scopes, custom parameters, language hints) and creates OAuthRequest instances that can be routed through the popup or redirect handlers registered on Auth.

Implementations

impl OAuthProvider

pub fn new( provider_id: impl Into<String>, authorization_endpoint: impl Into<String>, ) -> Self

Creates a new provider with the given ID and authorization endpoint.

pub fn provider_id(&self) -> &str

Returns the provider identifier (e.g. google.com).

pub fn authorization_endpoint(&self) -> &str

Returns the full authorization endpoint URL.

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

Returns the configured OAuth scopes.

pub fn custom_parameters(&self) -> &HashMap<String, String>

Returns any custom query parameters used when initiating flows.

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

Returns an optional user-facing display name for the provider.

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

Returns the preferred language hint for provider UX.

pub fn add_scope(&mut self, scope: impl Into<String>)

Adds a scope to the provider if it has not been added yet.

pub fn set_scopes<I, S>(&mut self, scopes: I)

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

Replaces the provider scopes with the provided list.

pub fn set_custom_parameters( &mut self, parameters: HashMap<String, String>, ) -> &mut Self

Overwrites the custom parameters included in authorization requests.

pub fn set_display_name(&mut self, value: impl Into<String>) -> &mut Self

Sets the user-visible display name.

pub fn set_language_code(&mut self, value: impl Into<String>) -> &mut Self

Sets the preferred language hint passed to the provider.

pub fn build_request(&self, auth: &Auth) -> AuthResult<OAuthRequest>

Builds the OAuthRequest that will be passed to popup/redirect handlers.

pub fn sign_in_with_popup(&self, auth: &Auth) -> AuthResult<UserCredential>

Runs the configured popup handler and returns the produced credential. Executes the sign-in flow using a popup handler.

pub fn link_with_popup(&self, auth: &Auth) -> AuthResult<UserCredential>

Links the current user with this provider using a popup flow.

pub fn sign_in_with_redirect(&self, auth: &Auth) -> AuthResult<()>

Delegates to the redirect handler to start a redirect based flow.

pub fn link_with_redirect(&self, auth: &Auth) -> AuthResult<()>

Initiates a redirect flow to link the current user with this provider.

pub fn get_redirect_result(auth: &Auth) -> AuthResult<Option<UserCredential>>

Completes a redirect flow using the registered redirect handler.

The provider does not influence result parsing at this stage; the handler is responsible for decoding whichever callback mechanism the hosting platform uses.

Trait Implementations

impl Clone for OAuthProvider

fn clone(&self) -> OAuthProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthProvider

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

Formats the value using the given formatter.