Struct elefren::registration::Registered

pub struct Registered<H: HttpSend> { /* fields omitted */ }

Represents the state of the auth flow when the app has been registered but the user is not authenticated

Methods

impl Registered<HttpSender>

pub fn from_parts(
    base: &str,
    client_id: &str,
    client_secret: &str,
    redirect: &str,
    scopes: Scopes,
    force_login: bool
) -> Registered<HttpSender>

Skip having to retrieve the client id and secret from the server by creating a Registered struct directly

Example

use elefren::{prelude::*, registration::Registered};

let registration = Registered::from_parts(
    "https://example.com",
    "the-client-id",
    "the-client-secret",
    "https://example.com/redirect",
    Scopes::read_all(),
    false,
);
let url = registration.authorize_url()?;
// Here you now need to open the url in the browser
// And handle a the redirect url coming back with the code.
let code = String::from("RETURNED_FROM_BROWSER");
let mastodon = registration.complete(&code)?;

println!("{:?}", mastodon.get_home_timeline()?.initial_items);

impl<H: HttpSend> Registered<H>

pub fn into_parts(self) -> (String, String, String, String, Scopes, bool)

Returns the parts of the Registered struct that can be used to recreate another Registered struct

Example

use elefren::{prelude::*, registration::Registered};

let origbase = "https://example.social";
let origclient_id = "some-client_id";
let origclient_secret = "some-client-secret";
let origredirect = "https://example.social/redirect";
let origscopes = Scopes::all();
let origforce_login = false;

let registered = Registered::from_parts(
    origbase,
    origclient_id,
    origclient_secret,
    origredirect,
    origscopes.clone(),
    origforce_login,
);

let (base, client_id, client_secret, redirect, scopes, force_login) = registered.into_parts();

assert_eq!(origbase, &base);
assert_eq!(origclient_id, &client_id);
assert_eq!(origclient_secret, &client_secret);
assert_eq!(origredirect, &redirect);
assert_eq!(origscopes, scopes);
assert_eq!(origforce_login, force_login);

pub fn authorize_url(&self) -> Result<String>

Returns the full url needed for authorisation. This needs to be opened in a browser.

pub fn complete(&self, code: &str) -> Result<Mastodon<H>>

Create an access token from the client id, client secret, and code provided by the authorisation url.

Trait Implementations

impl<H: Clone + HttpSend> Clone for Registered<H>

fn clone(&self) -> Registered<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug + HttpSend> Debug for Registered<H>

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

Formats the value using the given formatter.