Struct modio::auth::Auth

source ·
pub struct Auth { /* private fields */ }
Expand description

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§

source§

impl Auth

source

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.

source

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

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

source

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

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

source

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?;
source

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

Logout by revoking the current access token.

Trait Implementations§

source§

impl Clone for Auth

source§

fn clone(&self) -> Auth

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Auth

§

impl !RefUnwindSafe for Auth

§

impl Send for Auth

§

impl Sync for Auth

§

impl Unpin for Auth

§

impl !UnwindSafe for Auth

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more