Trait beatsaver_rs::BeatSaverApiAsync

pub trait BeatSaverApiAsync<'a, T: 'a + Error> where
    BeatSaverApiError<T>: From<T>, {
#[must_use]    pub fn request_raw<'async_trait>(
        &'a self, 
        url: Url
    ) -> Pin<Box<dyn Future<Output = Result<Bytes, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: 'async_trait;

#[must_use]    pub fn request<'async_trait>(
        &'a self, 
        url: Url
    ) -> Pin<Box<dyn Future<Output = Result<String, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[must_use]    pub fn map<'async_trait>(
        &'a self, 
        id: &'a MapId
    ) -> Pin<Box<dyn Future<Output = Result<Map, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn maps_by(
        &'a self, 
        user: &'a BeatSaverUser
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn maps_by_page<'async_trait>(
        &'a self, 
        user: &'a BeatSaverUser, 
        page: usize
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn maps_by_page_iter(
        &'a self, 
        user: &'a BeatSaverUser, 
        page: usize
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
    pub fn maps_hot(
        &'a self
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn maps_hot_page<'async_trait>(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn maps_hot_page_iter(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
    pub fn maps_rating(
        &'a self
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn maps_rating_page<'async_trait>(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn maps_rating_page_iter(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
    pub fn maps_latest(
        &'a self
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn maps_latest_page<'async_trait>(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn maps_latest_page_iter(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
    pub fn maps_downloads(
        &'a self
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn maps_downloads_page<'async_trait>(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn maps_downloads_page_iter(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
    pub fn maps_plays(
        &'a self
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn maps_plays_page<'async_trait>(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn maps_plays_page_iter(
        &'a self, 
        page: usize
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn user<'async_trait>(
        &'a self, 
        id: String
    ) -> Pin<Box<dyn Future<Output = Result<BeatSaverUser, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn search(
        &'a self, 
        query: &'a String
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn search_page<'async_trait>(
        &'a self, 
        query: &'a String, 
        page: usize
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn search_page_iter(
        &'a self, 
        query: &'a String, 
        page: usize
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
    pub fn search_advanced(
        &'a self, 
        query: &'a String
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn search_advanced_page<'async_trait>(
        &'a self, 
        query: &'a String, 
        page: usize
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
    pub fn search_advanced_page_iter(
        &'a self, 
        query: &'a String, 
        page: usize
    ) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>>
    where
        Self: Send + Sync,
    { ... }
#[must_use]    pub fn download<'async_trait>(
        &'a self, 
        id: MapId
    ) -> Pin<Box<dyn Future<Output = Result<Bytes, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
}

API trait for asynchronous clients

Required methods

#[must_use]pub fn request_raw<'async_trait>(
    &'a self,
    url: Url
) -> Pin<Box<dyn Future<Output = Result<Bytes, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Executes a raw request to the provided Url

Make sure to handle 429 (pass the data to rate_limit)

Loading content...

Provided methods

#[must_use]pub fn request<'async_trait>(
    &'a self,
    url: Url
) -> Pin<Box<dyn Future<Output = Result<String, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Executes a request and converts the result into a String

#[must_use]pub fn map<'async_trait>(
    &'a self,
    id: &'a MapId
) -> Pin<Box<dyn Future<Output = Result<Map, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Gets a map from a given MapId

pub fn maps_by(
    &'a self,
    user: &'a BeatSaverUser
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves maps created by a specified beatsaver user

#[must_use]pub fn maps_by_page<'async_trait>(
    &'a self,
    user: &'a BeatSaverUser,
    page: usize
) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves maps created by a specified beatsaver user, specifying a page number

pub fn maps_by_page_iter(
    &'a self,
    user: &'a BeatSaverUser,
    page: usize
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves maps created by a specified beatsaver user, specifying a page number, iterable

pub fn maps_hot(
    &'a self
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves the current hot maps on beatsaver

#[must_use]pub fn maps_hot_page<'async_trait>(
    &'a self,
    page: usize
) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves the current hot maps on beatsaver, specifying a page number

pub fn maps_hot_page_iter(
    &'a self,
    page: usize
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves the current hot maps on beatsaver, specifying a page number, iterable

pub fn maps_rating(
    &'a self
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves all maps sorted by rating

#[must_use]pub fn maps_rating_page<'async_trait>(
    &'a self,
    page: usize
) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves all maps sorted by rating, specifying a page number

pub fn maps_rating_page_iter(
    &'a self,
    page: usize
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves all maps sorted by rating, specifying a page number, iterable

pub fn maps_latest(
    &'a self
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves all maps sorted by upload time

#[must_use]pub fn maps_latest_page<'async_trait>(
    &'a self,
    page: usize
) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves all maps sorted by upload time, specifying a page number

pub fn maps_latest_page_iter(
    &'a self,
    page: usize
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves all maps sorted by upload time, specifying a page number, iterable

pub fn maps_downloads(
    &'a self
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves all maps sorted by total downloads

#[must_use]pub fn maps_downloads_page<'async_trait>(
    &'a self,
    page: usize
) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves all maps sorted by total downloads, specifying a page number

pub fn maps_downloads_page_iter(
    &'a self,
    page: usize
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves all maps sorted by total downloads, specifying a page number, iterable

pub fn maps_plays(
    &'a self
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves all maps sorted by number of plays, specifying a page number

#[must_use]pub fn maps_plays_page<'async_trait>(
    &'a self,
    page: usize
) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves all maps sorted by number of plays

pub fn maps_plays_page_iter(
    &'a self,
    page: usize
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves all maps sorted by number of plays, iterable

#[must_use]pub fn user<'async_trait>(
    &'a self,
    id: String
) -> Pin<Box<dyn Future<Output = Result<BeatSaverUser, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves info on a specified beatsaber user

pub fn search(
    &'a self,
    query: &'a String
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves maps based on a specified search query

Note: urlencodes the query

#[must_use]pub fn search_page<'async_trait>(
    &'a self,
    query: &'a String,
    page: usize
) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves maps based on a specified search query, specifying a page number

Note: urlencodes the query

pub fn search_page_iter(
    &'a self,
    query: &'a String,
    page: usize
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves maps based on a specified search query, specifying a page number, iterable

Note: urlencodes the query

pub fn search_advanced(
    &'a self,
    query: &'a String
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves maps based on an advanced search query

Note: urlencodes the query

Advanced queries use Apache Lucene syntax

#[must_use]pub fn search_advanced_page<'async_trait>(
    &'a self,
    query: &'a String,
    page: usize
) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Retrieves maps based on an advanced search query, specifying a page number

Note: urlencodes the query

Advanced queries use Apache Lucene syntax

pub fn search_advanced_page_iter(
    &'a self,
    query: &'a String,
    page: usize
) -> Pin<Box<dyn Stream<Item = Result<Map, BeatSaverApiError<T>>> + 'a>> where
    Self: Send + Sync, 

Retrieves maps based on an advanced search query, specifying a page number, iterable

Note: urlencodes the query

Advanced queries use Apache Lucene syntax

#[must_use]pub fn download<'async_trait>(
    &'a self,
    id: MapId
) -> Pin<Box<dyn Future<Output = Result<Bytes, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Sync + 'async_trait, 

Downloads a provided map

Maps can be converted to MapIds using the Into trait.

Loading content...

Implementors

impl<'a> BeatSaverApiAsync<'a, Error> for BeatSaverReqwest

pub fn request_raw<'async_trait>(
    &'a self,
    url: Url
) -> Pin<Box<dyn Future<Output = Result<Bytes, BeatSaverApiError<Error>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Loading content...