Struct rosu_v2::OsuBuilder

source · [−]

pub struct OsuBuilder { /* private fields */ }

Expand description

Builder struct for an Osu client.

client_id as well as client_secret must be specified before building.

For more info, check out https://osu.ppy.sh/docs/index.html#client-credentials-grant

Implementations

source

impl OsuBuilder

source

pub fn new() -> Self

Create a new OsuBuilder

source

pub async fn build(self) -> OsuResult<Osu>

Build an Osu client.

To build the client, the client id and secret are being used to acquire a token from the API which expires after a certain time. The client will from then on update the token regularly on its own.

Errors

Returns an error if

client id was not set
client secret was not set
API did not provide a token for the given client id and client secret

source

pub fn client_id(self, client_id: u64) -> Self

Set the client id of the application.

For more info, check out https://osu.ppy.sh/docs/index.html#client-credentials-grant

source

pub fn client_secret(self, client_secret: impl Into<String>) -> Self

Set the client secret of the application.

For more info, check out https://osu.ppy.sh/docs/index.html#client-credentials-grant

source

pub fn with_authorization(
 self,
 code: impl Into<String>,
 redirect_uri: impl Into<String>
) -> Self

After acquiring the authorization code from a user through OAuth, use this method to provide the given code, and specified redirect uri.

For more info, check out https://osu.ppy.sh/docs/index.html#authorization-code-grant

source

pub fn timeout(self, duration: Duration) -> Self

Set the timeout for HTTP requests, defaults to 10 seconds.

Trait Implementations

source

impl Default for OsuBuilder

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for OsuBuilder

impl Send for OsuBuilder

impl Sync for OsuBuilder

impl Unpin for OsuBuilder

impl UnwindSafe for OsuBuilder

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub 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 for T where
U: From<T>,

const: unstable · source

pub 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::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

Struct rosu_v2::OsuBuilder

Implementations

impl OsuBuilder

pub fn new() -> Self

pub async fn build(self) -> OsuResult<Osu>

Errors

pub fn client_id(self, client_id: u64) -> Self

pub fn client_secret(self, client_secret: impl Into<String>) -> Self

pub fn with_authorization( self, code: impl Into<String>, redirect_uri: impl Into<String>) -> Self

pub fn timeout(self, duration: Duration) -> Self

Trait Implementations

impl Default for OsuBuilder

fn default() -> Self

Auto Trait Implementations

impl RefUnwindSafe for OsuBuilder

impl Send for OsuBuilder

impl Sync for OsuBuilder

impl Unpin for OsuBuilder

impl UnwindSafe for OsuBuilder

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn with_authorization(
self,
code: impl Into<String>,
redirect_uri: impl Into<String>
) -> Self

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

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

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

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

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

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

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