Struct rosu::backend::requests::UserRequest

pub struct UserRequest<'s> { /* fields omitted */ }

Request struct to retrieve users. An instance must contain either a user id or a username

Methods

impl<'s> UserRequest<'s>

pub fn with_user_id(id: u32) -> Self

Construct a UserRequest via user id

pub fn with_username(name: &str) -> Self

Construct a UserRequest via username

pub fn mode(self, mode: GameMode) -> Self

Specify a game mode for the request

pub fn event_days(self, amount: u32) -> Self

Specify event days for the request.

From osu!api repo: Max number of days between now and last event date. Range of 1-31. Optional, default value is 1

pub async fn queue<'_>(self, osu: &'_ Osu) -> OsuResult<Vec<User>>

Asynchronously send the user request and await the parsed Vec<User>.

Example

use rosu::{
    backend::{Osu, requests::UserRequest},
    models::User,
};

let osu = Osu::new("osu_api_key");
let request: UserRequest = UserRequest::with_username("Badewanne3");
let users: Vec<User> = request.queue(&osu).await?;
// ...

pub async fn queue_single<'_>(self, osu: &'_ Osu) -> OsuResult<Option<User>>

Asynchronously send the user request and await the parsed User.

If the API's response contains more than one user, the method will return the last one.

If the API response contains no users, the method will return None.

Example

use rosu::{
    backend::{Osu, requests::UserRequest},
    models::User,
};

let osu = Osu::new("osu_api_key");
let request: UserRequest = UserRequest::with_username("Badewanne3");
let user: Option<User> = request.queue_single(&osu).await?;
// ...

Trait Implementations

impl<'s> Clone for UserRequest<'s>

fn clone(&self) -> UserRequest<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Eq for UserRequest<'s>

impl<'s> PartialEq<UserRequest<'s>> for UserRequest<'s>

fn eq(&self, other: &UserRequest<'s>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UserRequest<'s>) -> bool

This method tests for !=.

impl<'s> StructuralEq for UserRequest<'s>

impl<'s> StructuralPartialEq for UserRequest<'s>