Struct modio::auth::Auth

pub struct Auth { /* private fields */ }

Authentication Flow interface to retrieve access tokens. See the mod.io Authentication docs for more information.

Example

use std::io::{self, Write};

use modio::{Credentials, Modio, Result};

fn prompt(prompt: &str) -> io::Result<String> {
    print!("{}", prompt);
    io::stdout().flush()?;
    let mut buffer = String::new();
    io::stdin().read_line(&mut buffer)?;
    Ok(buffer.trim().to_string())
}

#[tokio::main]
async fn main() -> Result<()> {
    let modio = Modio::new(Credentials::new("api-key"))?;

    let email = prompt("Enter email: ").expect("read email");
    modio.auth().request_code(&email).await?;

    let code = prompt("Enter security code: ").expect("read code");
    let token = modio.auth().security_code(&code).await?;

    // Consume the endpoint and create an endpoint with new credentials.
    let _modio = modio.with_credentials(token);

    Ok(())
}

Implementations

impl Auth

pub async fn terms(self) -> Result<Terms>

Get text and links for user agreement and consent prior to authentication. [required: apikey]

See the mod.io docs for more information.

pub async fn request_code(self, email: &str) -> Result<()>

Request a security code be sent to the email of the user. [required: apikey]

pub async fn security_code(self, code: &str) -> Result<Credentials>

Get the access token for a security code. [required: apikey]

pub async fn external<T>(self, auth_options: T) -> Result<Credentials>

where T: Into<AuthOptions>,

Authenticate via external services (Steam, Switch, Xbox, Discord, Oculus, Google).

See the mod.io docs for more information.

Examples

use modio::auth::SteamOptions;
let opts = SteamOptions::new("ticket");
modio.auth().external(opts).await?;

pub async fn logout(self) -> Result<()>

Logout by revoking the current access token.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a copy of the value.

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

Performs copy-assignment from source.