Struct AppBuilder 

pub struct AppBuilder<'a> { /* private fields */ }

Builder struct for defining your application.

use mastodon_async::{apps::App};

let mut builder = App::builder();
builder.client_name("mastodon-async_test");
let app = builder.build().unwrap();

Implementations

impl<'a> AppBuilder<'a>

pub fn new() -> Self

Creates a new AppBuilder object

pub fn client_name<I: Into<Cow<'a, str>>>(&mut self, name: I) -> &mut Self

Name of the application. Will be displayed when the user is deciding to grant permission.

In order to turn this builder into an App, this needs to be provided

pub fn redirect_uris<I: Into<Cow<'a, str>>>(&mut self, uris: I) -> &mut Self

Where the user should be redirected after authorization

If none is specified, the default is urn:ietf:wg:oauth:2.0:oob

pub fn scopes(&mut self, scopes: Scopes) -> &mut Self

Permission scope of the application.

IF none is specified, the default is Scopes::read_all()

pub fn website<I: Into<Cow<'a, str>>>(&mut self, website: I) -> &mut Self

URL to the homepage of your application.

pub fn build(self) -> Result<App>

Attempts to convert this build into an App

Will fail if no client_name was provided

Trait Implementations

impl<'a> Clone for AppBuilder<'a>

fn clone(&self) -> AppBuilder<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AppBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for AppBuilder<'a>

fn default() -> AppBuilder<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for AppBuilder<'a>

fn eq(&self, other: &AppBuilder<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for AppBuilder<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryInto<App> for AppBuilder<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<App>

Performs the conversion.

impl<'a> StructuralPartialEq for AppBuilder<'a>