Struct Auth 

pub struct Auth { /* private fields */ }

Implementations

impl Auth

pub fn builder(app: FirebaseApp) -> AuthBuilder

Creates a builder for configuring an Auth instance before construction.

pub fn new(app: FirebaseApp) -> AuthResult<Self>

Constructs an Auth instance using in-memory persistence.

pub fn new_with_persistence( app: FirebaseApp, persistence: Arc<dyn AuthPersistence + Send + Sync>, ) -> AuthResult<Self>

Constructs an Auth instance with a caller-provided persistence backend.

pub fn initialize(self: &Arc<Self>) -> AuthResult<()>

Finishes initialization by restoring persisted state and wiring listeners.

pub fn app(&self) -> &FirebaseApp

Returns the FirebaseApp associated with this Auth instance.

pub fn current_user(&self) -> Option<Arc<User>>

Returns the currently signed-in user, if any.

pub fn sign_out(&self)

Signs out the current user and clears persisted credentials.

pub fn email_auth_provider(&self) -> EmailAuthProvider

Returns the email/password auth provider helper.

pub fn sign_in_with_email_and_password( &self, email: &str, password: &str, ) -> AuthResult<UserCredential>

Signs a user in using the email/password REST endpoint.

pub fn create_user_with_email_and_password( &self, email: &str, password: &str, ) -> AuthResult<UserCredential>

Creates a new user using email/password credentials.

pub fn on_auth_state_changed( &self, observer: PartialObserver<Arc<User>>, ) -> impl FnOnce() + Send + 'static

Registers an observer that is invoked whenever auth state changes.

pub fn get_token(&self, force_refresh: bool) -> AuthResult<Option<String>>

Returns the current user’s ID token, refreshing when requested.

pub fn token_provider(self: &Arc<Self>) -> TokenProviderArc

Exposes this auth instance as a Firestore token provider.

pub fn set_oauth_request_uri(&self, value: impl Into<String>)

Overrides the default OAuth request URI used during flows.

pub fn oauth_request_uri(&self) -> String

Returns the OAuth request URI for popup/redirect flows.

pub fn set_identity_toolkit_endpoint(&self, endpoint: impl Into<String>)

Updates the Identity Toolkit REST endpoint.

pub fn identity_toolkit_endpoint(&self) -> String

Returns the Identity Toolkit REST endpoint in use.

pub fn set_secure_token_endpoint(&self, endpoint: impl Into<String>)

Sets the Secure Token endpoint used for refresh operations.

pub fn set_popup_handler(&self, handler: Arc<dyn OAuthPopupHandler>)

Installs an OAuth popup handler implementation.

pub fn clear_popup_handler(&self)

Clears any installed popup handler.

pub fn popup_handler(&self) -> Option<Arc<dyn OAuthPopupHandler>>

Retrieves the currently configured popup handler.

pub fn set_redirect_handler(&self, handler: Arc<dyn OAuthRedirectHandler>)

Installs an OAuth redirect handler implementation.

pub fn clear_redirect_handler(&self)

Clears any installed redirect handler.

pub fn redirect_handler(&self) -> Option<Arc<dyn OAuthRedirectHandler>>

Retrieves the currently configured redirect handler.

pub fn set_redirect_persistence( &self, persistence: Arc<dyn RedirectPersistence>, )

Replaces the persistence mechanism used for redirect state.

pub fn sign_in_with_oauth_credential( &self, credential: AuthCredential, ) -> AuthResult<UserCredential>

Signs in using an OAuth credential produced by popup/redirect flows.

pub fn send_password_reset_email(&self, email: &str) -> AuthResult<()>

Sends a password reset email to the specified address.

pub fn confirm_password_reset( &self, oob_code: &str, new_password: &str, ) -> AuthResult<()>

Confirms a password reset OOB code and applies the new password.

pub fn send_email_verification(&self) -> AuthResult<()>

Sends an email verification message to the currently signed-in user.

pub fn update_profile( &self, display_name: Option<&str>, photo_url: Option<&str>, ) -> AuthResult<Arc<User>>

Updates the current user’s display name and photo URL.

pub fn update_email(&self, email: &str) -> AuthResult<Arc<User>>

Updates the current user’s email address.

pub fn update_password(&self, password: &str) -> AuthResult<Arc<User>>

Updates the current user’s password.

pub fn delete_user(&self) -> AuthResult<()>

Deletes the current user from Firebase Auth.

pub fn unlink_providers(&self, provider_ids: &[&str]) -> AuthResult<Arc<User>>

Unlinks the specified providers from the current user.

pub fn get_account_info(&self) -> AuthResult<GetAccountInfoResponse>

Fetches the latest account info for the current user.

pub fn link_with_oauth_credential( &self, credential: AuthCredential, ) -> AuthResult<UserCredential>

Links an OAuth credential with the currently signed-in user.

pub fn reauthenticate_with_password( &self, email: &str, password: &str, ) -> AuthResult<Arc<User>>

Reauthenticates the current user with email and password.

pub fn reauthenticate_with_oauth_credential( &self, credential: AuthCredential, ) -> AuthResult<Arc<User>>

Reauthenticates the current user with an OAuth credential.