Struct NadeoClient

pub struct NadeoClient {
    pub user_agent: UserAgentDetails,
    pub max_concurrent_requests: usize,
    /* private fields */
}

Main client for nadeo services

Fields

user_agent: UserAgentDetails

max_concurrent_requests: usize

Implementations

impl NadeoClient

pub fn get_authz_header_for_auth(&self) -> String

pub async fn create( credentials: NadeoCredentials, user_agent: UserAgentDetails, max_concurrent_requests: usize, ) -> Result<Self, NadeoError>

pub fn with_oauth(self, oauth: OAuthCredentials) -> Option<Self>

pub async fn ensure_tokens_valid(&self)

pub async fn calc_avg_req_per_sec(&self) -> f64

pub async fn get_cached_avg_req_per_sec(&self) -> f64

pub async fn get_nb_reqs(&self) -> usize

pub fn get_batcher(&self) -> &BatcherLbPosByTime

Trait Implementations

impl CoreApiClient for NadeoClient

async fn get_zones(&self) -> Result<Vec<Zone>, NadeoError>

Get a list of zones

async fn get_zone_tree(&self) -> Result<&ZoneTree, NadeoError>

Get the zone tree – cached!

async fn get_user_zones<T: Into<String> + Clone>( &self, player_ids: &[T], ) -> Result<HashMap<String, PlayerZone>, NadeoError>

Get players’ zone details

impl LiveApiClient for NadeoClient

async fn push_rec_position_req( &'static self, map_uid: &str, score: i64, ) -> Receiver<ScoreToPos>

Internal method supporting get_lb_position_by_time_batched

async fn get_monthly_campaign( &self, ty: MonthlyCampaignType, length: u32, offset: u32, ) -> Result<MonthlyCampaign_List, NadeoError>

Get TOTDs / Royal maps

async fn get_map_group_leaderboard( &self, group_uid: &str, map_uid: &str, only_world: bool, length: u32, offset: u32, ) -> Result<MapGroupLeaderboard, NadeoError>

https://webservices.openplanet.dev/live/leaderboards/top

async fn get_map_leaderboard( &self, map_uid: &str, only_world: bool, length: u32, offset: u32, ) -> Result<MapGroupLeaderboard, NadeoError>

Personal_Best LB

async fn get_lb_positions_by_time( &self, uid_scores: &[(&str, NonZero<u32>)], ) -> Result<Vec<RecordsByTime>, NadeoError>

https://webservices.openplanet.dev/live/leaderboards/position

async fn get_lb_positions_by_time_group( &self, uid_scores: &[(&str, NonZero<u32>)], group_uid: &str, ) -> Result<Vec<RecordsByTime>, NadeoError>

https://webservices.openplanet.dev/live/leaderboards/position

async fn get_lb_position_by_time_batched( &'static self, map_uid: &str, score: NonZero<u32>, ) -> Result<ScoreToPos, RecvError>

https://webservices.openplanet.dev/live/leaderboards/position

async fn get_group_surround( &self, group_uid: &str, map_uid: &str, lower: i32, upper: i32, score: u32, only_world: bool, ) -> Result<RecordsSurround, NadeoError>

https://webservices.openplanet.dev/live/leaderboards/surround

async fn get_pb_surround( &self, map_uid: &str, lower: i32, upper: i32, score: u32, only_world: bool, ) -> Result<RecordsSurround, NadeoError>

Surround on the Personal_Best group

async fn get_map_info( &self, map_uid: &str, ) -> Result<Option<MapInfo>, NadeoError>

https://webservices.openplanet.dev/live/maps/info

async fn get_map_info_multiple( &self, map_uids: &[&str], ) -> Result<MapInfos, NadeoError>

https://webservices.openplanet.dev/live/maps/info-multiple

async fn get_club_activities( &self, club_id: i32, length: u32, offset: u32, active: bool, ) -> Result<ClubActivityList, NadeoError>

https://webservices.openplanet.dev/live/clubs/activities

async fn get_club_info(&self, club_id: i32) -> Result<ClubInfo, NadeoError>

https://webservices.openplanet.dev/live/clubs/club

async fn get_club_campaign_by_id( &self, club_id: i32, campaign_id: i32, ) -> Result<ClubCampaignById, NadeoError>

https://webservices.openplanet.dev/live/clubs/campaign-by-id

async fn get_club_campaigns( &self, length: u32, offset: u32, name: Option<&str>, ) -> Result<ClubCampaignList, NadeoError>

https://webservices.openplanet.dev/live/clubs/campaigns

async fn get_club_rooms( &self, length: u32, offset: u32, name: Option<&str>, ) -> Result<ClubRoomList, NadeoError>

https://webservices.openplanet.dev/live/clubs/rooms

async fn get_club_room_by_id( &self, club_id: i32, activity_id: i32, ) -> Result<ClubRoom, NadeoError>

https://webservices.openplanet.dev/live/clubs/room-by-id

async fn edit_club_room_by_id( &self, club_id: i32, activity_id: i32, body: &ClubRoom_Room_ForEdit, ) -> Result<ClubRoom, NadeoError>

async fn create_club_room( &self, club_id: i32, body: &ClubRoom_Room_ForEdit, ) -> Result<ClubRoom, NadeoError>

async fn get_club_activity_list( &self, club_id: i32, length: u32, offset: u32, active: Option<bool>, ) -> Result<ActivityList, NadeoError>

https://webservices.openplanet.dev/live/clubs/activities

async fn edit_club_activity( &self, club_id: i32, activity_id: i32, public: Option<bool>, active: Option<bool>, ) -> Result<Value, NadeoError>

async fn get_clubs( &self, length: u32, offset: u32, name: Option<&str>, ) -> Result<ClubList, NadeoError>

https://webservices.openplanet.dev/live/clubs/clubs

async fn get_clubs_mine( &self, length: u32, offset: u32, ) -> Result<ClubList, NadeoError>

impl MeetApiClient for NadeoClient

async fn get_cup_of_the_day(&self) -> Result<Option<CupOfTheDay>, NadeoError>

https://webservices.openplanet.dev/meet/cup-of-the-day/current

impl NadeoApiClient for NadeoClient

fn get_auth_token( &self, audience: NadeoAudience, ) -> Result<String, TryLockError>

Prefer: aget_auth_token Get the auth token for the given audience (used to construct the header)

async fn aget_auth_token(&self, audience: NadeoAudience) -> String

Get the auth token for the given audience (used to construct the header)

async fn get_client(&self) -> &Client

async fn rate_limit(&self) -> SemaphorePermit<'_>

async fn get_file_size(&self, url: &str) -> Result<u64, RqError>

fn get_auth_header( &self, audience: NadeoAudience, ) -> Result<String, TryLockError>

async fn aget_auth_header(&self, audience: NadeoAudience) -> String

async fn get_auth_header_value(&self, audience: NadeoAudience) -> HeaderValue

async fn oauth_get<'a>( &self, path: &str, token: &OAuthToken, _permit: &SemaphorePermit<'a>, ) -> RequestBuilder

async fn core_get(&self, path: &str) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_core_get(&self, path: &str) -> Result<Value, RqError>

async fn core_post_bytes( &self, path: &str, body: &[u8], ) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_core_post_bytes( &self, path: &str, body: &[u8], ) -> Result<Value, RqError>

async fn core_post( &self, path: &str, body: &Value, ) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_core_post( &self, path: &str, body: &Value, ) -> Result<Value, RqError>

async fn live_get(&self, path: &str) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_live_get(&self, path: &str) -> Result<Value, RqError>

async fn live_post_bytes( &self, path: &str, body: &[u8], ) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_live_post_bytes( &self, path: &str, body: &[u8], ) -> Result<Value, RqError>

async fn live_post( &self, path: &str, body: &Value, ) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_live_post( &self, path: &str, body: &Value, ) -> Result<Value, RqError>

async fn meet_get(&self, path: &str) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_meet_get(&self, path: &str) -> Result<Value, RqError>

async fn meet_post_bytes( &self, path: &str, body: &[u8], ) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_meet_post_bytes( &self, path: &str, body: &[u8], ) -> Result<Value, RqError>

async fn meet_post( &self, path: &str, body: &Value, ) -> (RequestBuilder, SemaphorePermit<'_>)

async fn run_meet_post( &self, path: &str, body: &Value, ) -> Result<Value, RqError>

impl OAuthApiClient for NadeoClient

async fn get_oauth_token(&self) -> Result<OAuthToken, String>

For adding API requests, use get_oauth_permit_and_token.

async fn get_oauth_permit_and_token( &self, ) -> Result<(OAuthToken, SemaphorePermit<'_>), String>

async fn get_display_names<T>( &self, account_ids: &[T], ) -> Result<HashMap<String, String>, String>

where T: Into<String> + Clone,

Get Display Names for a list of Uuids