[][src]Struct rosu::Osu

pub struct Osu(_);

The main osu client. Cheap to clone.

Implementations

impl Osu[src]

pub fn new(api_key: impl Into<String>) -> Self[src]

Create a new Osu client.

pub fn builder(api_key: impl Into<String>) -> OsuBuilder[src]

Create a new builder to build an Osu struct.

pub fn user(&self, user: impl Into<UserIdentification>) -> GetUser<'_>

Notable traits for GetUser<'_>

impl Future for GetUser<'_> type Output = OsuResult<Option<User>>;
[src]

Request an optional User.

pub fn beatmap(&self) -> GetBeatmap<'_>

Notable traits for GetBeatmap<'_>

impl Future for GetBeatmap<'_> type Output = OsuResult<Option<Beatmap>>;
[src]

Request an optional Beatmap.

pub fn beatmaps(&self) -> GetBeatmaps<'_>

Notable traits for GetBeatmaps<'_>

impl Future for GetBeatmaps<'_> type Output = OsuResult<Vec<Beatmap>>;
[src]

Request a vec of Beatmaps.

pub fn osu_match(&self, match_id: u32) -> GetMatch<'_>

Notable traits for GetMatch<'a>

impl<'a> Future for GetMatch<'a> type Output = OsuResult<Match>;
[src]

Request the Match with the given match_id.

pub fn score(&self, map_id: u32) -> GetScore<'_>

Notable traits for GetScore<'_>

impl Future for GetScore<'_> type Output = OsuResult<Option<Score>>;
[src]

Request an optional Score on the given map_id.

pub fn scores(&self, map_id: u32) -> GetScores<'_>

Notable traits for GetScores<'_>

impl Future for GetScores<'_> type Output = OsuResult<Vec<Score>>;
[src]

Request a vec of Scores on the given map_id.

pub fn top_scores(&self, user: impl Into<UserIdentification>) -> GetUserBest<'_>

Notable traits for GetUserBest<'_>

impl Future for GetUserBest<'_> type Output = OsuResult<Vec<Score>>;
[src]

Request a vec of Scores namely the top scores of the given user.

pub fn recent_scores(
    &self,
    user: impl Into<UserIdentification>
) -> GetUserRecent<'_>

Notable traits for GetUserRecent<'_>

impl Future for GetUserRecent<'_> type Output = OsuResult<Vec<Score>>;
[src]

Request a vec of Scores namely the most recent scores of the given user.

Auto Trait Implementations

impl !RefUnwindSafe for Osu[src]

impl Send for Osu[src]

impl Sync for Osu[src]

impl Unpin for Osu[src]

impl !UnwindSafe for Osu[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.