Struct FirebaseAuthBuilder

pub struct FirebaseAuthBuilder { /* private fields */ }

Implementations

impl FirebaseAuthBuilder

pub fn new() -> Self

pub fn admin_credentials( self, admin_credentials: FirebaseAdminCredentials, ) -> Self

Add credentials to the builder

Example

let credentials = FirebaseAdminCredentials::new(
    "my-project".to_string(),
    "my-private-key-id".to_string(),
    "my-private-key".to_string(),
    "my-client-email".to_string(),
    "my-client-id".to_string(),
);

let auth = FirebaseAuth::builder()
    .admin_credentials(credentials)
    .build()
    .unwrap();

pub fn jwks_url(self, jwks_url: &str) -> Self

Add a custom jwks_url to the builder

This is useful when you want to mock the jwks endpoint in tests or when you want to use a custom jwks endpoint in staging or development environments.

Example

let auth = FirebaseAuth::builder()
    .jwks_url("https://my-custom-jwks-url.com")
    .build()
    .unwrap();

pub fn env(self, variable_name: &str) -> Self

Set credentials by reading from .env file

If you want to specify a custom .env file, use the env_file function. This function will specifically read from the .env file.

Example

let auth = FirebaseAuth::builder()
    .env("FIREBASE_CREDENTIALS")
    .build()
    .unwrap();

pub fn env_file(self, filepath: &str, variable_name: &str) -> Self

Set credentials by providing a dotenv filepath

This function is will most likely find its way in the codebase when supplying the FirebaseAuth dummy values in tests, or if the user stringified the json credentials and stored it in a .env file.

Example

let auth = FirebaseAuth::builder()
    .env_file(".env", "FIREBASE_CREDENTIALS")
    .build()
    .unwrap();

pub fn json_file(self, filepath: &str) -> Self

Set credentials by providing a json filepath

Example

let auth = FirebaseAuth::builder()
    .json_file("credentials.json")
    .build()
    .unwrap();

pub fn build(self) -> Result<FirebaseAuth, Error>

Build the FirebaseAuth instance

Tries to build the FirebaseAuth instance from the provided config values. If the env_file or json_file functions were used, this function will try to read the file and parse the credentials from it. Credentials will be set by the function last used to set them (for example, if you call env_file and then credentials, the credentials set by credentials function will be used).

Example

let auth = FirebaseAuth::builder()
    .build()
    .unwrap();

Trait Implementations

impl Clone for FirebaseAuthBuilder

fn clone(&self) -> FirebaseAuthBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirebaseAuthBuilder

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

Formats the value using the given formatter.

impl Default for FirebaseAuthBuilder

fn default() -> Self

Returns the “default value” for a type.