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, 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<'life0, 'async_trait>(
        &'a self, 
        id: &'life0 MapId
    ) -> Pin<Box<dyn Future<Output = Result<Map, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        'life0: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[must_use]    pub fn maps_by<'life0, 'async_trait>(
        &'a self, 
        user: &'life0 BeatSaverUser
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        'life0: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[must_use]    pub fn maps_hot<'async_trait>(
        &'a self
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[must_use]    pub fn maps_rating<'async_trait>(
        &'a self
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[must_use]    pub fn maps_latest<'async_trait>(
        &'a self
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[must_use]    pub fn maps_downloads<'async_trait>(
        &'a self
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[must_use]    pub fn maps_plays<'async_trait>(
        &'a self
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[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,
    { ... }
#[must_use]    pub fn search<'async_trait>(
        &'a self, 
        query: String
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[must_use]    pub fn search_advanced<'async_trait>(
        &'a self, 
        query: String
    ) -> Pin<Box<dyn Future<Output = Result<Page<Map>, BeatSaverApiError<T>>> + Send + 'async_trait>>
    where
        'a: 'async_trait,
        Self: Sync + 'async_trait,
    { ... }
#[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, T>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Executes a raw request to the provided Url

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<'life0, 'async_trait>(
    &'a self,
    id: &'life0 MapId
) -> Pin<Box<dyn Future<Output = Result<Map, BeatSaverApiError<T>>> + Send + 'async_trait>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Gets a map from a given MapId

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

Retrieves maps created by a specified beatsaver user

#[must_use]pub fn maps_hot<'async_trait>(
    &'a self
) -> 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

#[must_use]pub fn maps_rating<'async_trait>(
    &'a self
) -> 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

#[must_use]pub fn maps_latest<'async_trait>(
    &'a self
) -> 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

#[must_use]pub fn maps_downloads<'async_trait>(
    &'a self
) -> 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

#[must_use]pub fn maps_plays<'async_trait>(
    &'a self
) -> 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

#[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

#[must_use]pub fn search<'async_trait>(
    &'a self,
    query: String
) -> 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

Note: urlencodes the query

#[must_use]pub fn search_advanced<'async_trait>(
    &'a self,
    query: String
) -> 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

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, Error>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Loading content...