[−][src]Struct licoricedev::client::Lichess
The base client onject
Implementations
impl Lichess
[src]
pub async fn get_my_profile(&self) -> LichessResult<User>
[src]
pub async fn get_my_email_address(&self) -> LichessResult<String>
[src]
pub async fn get_my_preferences(&self) -> LichessResult<UserPreferences>
[src]
pub async fn get_my_kid_mode_status(&self) -> LichessResult<bool>
[src]
pub async fn set_my_kid_mode_status(&self, value: bool) -> LichessResult<()>
[src]
impl Lichess
[src]
pub async fn arena_current(&self) -> LichessResult<ArenaSchedule>
[src]
pub async fn arena_new(
&self,
clock_time: u16,
clock_increment: u8,
minutes: u16,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<ArenaTournament>
[src]
&self,
clock_time: u16,
clock_increment: u8,
minutes: u16,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<ArenaTournament>
pub async fn arena_info(
&self,
id: &str,
page: u8
) -> LichessResult<ArenaTournament>
[src]
&self,
id: &str,
page: u8
) -> LichessResult<ArenaTournament>
pub async fn games_by_arena_pgn(
&self,
id: &str,
query_params: Option<Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Bytes>>>
[src]
&self,
id: &str,
query_params: Option<Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Bytes>>>
pub async fn games_by_arena_json(
&self,
id: &str,
query_params: Option<Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
[src]
&self,
id: &str,
query_params: Option<Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
pub async fn results_by_arena(
&self,
id: &str,
nb_players: u16
) -> LichessResult<impl Stream<Item = LichessResult<PlayerStandings>>>
[src]
&self,
id: &str,
nb_players: u16
) -> LichessResult<impl Stream<Item = LichessResult<PlayerStandings>>>
pub async fn teams_by_arena(&self, id: &str) -> LichessResult<TeamStandings>
[src]
pub async fn arenas_by_user(
&self,
username: &str,
nb_tournamensts: u16
) -> LichessResult<impl Stream<Item = LichessResult<ArenaTournament>>>
[src]
&self,
username: &str,
nb_tournamensts: u16
) -> LichessResult<impl Stream<Item = LichessResult<ArenaTournament>>>
impl Lichess
[src]
pub async fn stream_incoming_events(
&self
) -> LichessResult<impl Stream<Item = LichessResult<Event>>>
[src]
&self
) -> LichessResult<impl Stream<Item = LichessResult<Event>>>
pub async fn create_a_seek(
&self,
time: u8,
increment: u8,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<impl Stream<Item = LichessResult<Bytes>>>
[src]
&self,
time: u8,
increment: u8,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<impl Stream<Item = LichessResult<Bytes>>>
pub async fn stream_board_game_state(
&self,
game_id: &str
) -> LichessResult<impl Stream<Item = LichessResult<BoardState>>>
[src]
&self,
game_id: &str
) -> LichessResult<impl Stream<Item = LichessResult<BoardState>>>
pub async fn make_a_board_move(
&self,
game_id: &str,
r#move: &str,
offering_draw: bool
) -> LichessResult<()>
[src]
&self,
game_id: &str,
r#move: &str,
offering_draw: bool
) -> LichessResult<()>
pub async fn write_in_board_chat(
&self,
game_id: &str,
room: &str,
text: &str
) -> LichessResult<()>
[src]
&self,
game_id: &str,
room: &str,
text: &str
) -> LichessResult<()>
pub async fn abort_board_game(&self, game_id: &str) -> LichessResult<()>
[src]
pub async fn resign_board_game(&self, game_id: &str) -> LichessResult<()>
[src]
pub async fn handle_draw_offers(
&self,
game_id: &str,
accept: bool
) -> LichessResult<()>
[src]
&self,
game_id: &str,
accept: bool
) -> LichessResult<()>
impl Lichess
[src]
pub async fn upgrade_to_bot_account(&self) -> LichessResult<()>
[src]
pub async fn stream_bot_game_state(
&self,
game_id: &str
) -> LichessResult<impl Stream<Item = LichessResult<BoardState>>>
[src]
&self,
game_id: &str
) -> LichessResult<impl Stream<Item = LichessResult<BoardState>>>
pub async fn make_a_bot_move(
&self,
game_id: &str,
r#move: &str,
offering_draw: bool
) -> LichessResult<()>
[src]
&self,
game_id: &str,
r#move: &str,
offering_draw: bool
) -> LichessResult<()>
pub async fn write_in_bot_chat(
&self,
game_id: &str,
room: &str,
text: &str
) -> LichessResult<()>
[src]
&self,
game_id: &str,
room: &str,
text: &str
) -> LichessResult<()>
pub async fn abort_bot_game(&self, game_id: &str) -> LichessResult<()>
[src]
pub async fn resign_bot_game(&self, game_id: &str) -> LichessResult<()>
[src]
impl Lichess
[src]
pub async fn get_official_broadcasts(
&self,
nb_broadcasts: u8
) -> LichessResult<impl Stream<Item = LichessResult<Broadcast>>>
[src]
&self,
nb_broadcasts: u8
) -> LichessResult<impl Stream<Item = LichessResult<Broadcast>>>
pub async fn create_broadcast(
&self,
name: &str,
description: &str,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<Broadcast>
[src]
&self,
name: &str,
description: &str,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<Broadcast>
pub async fn get_broadcast(
&self,
broadcast_id: &str
) -> LichessResult<Broadcast>
[src]
&self,
broadcast_id: &str
) -> LichessResult<Broadcast>
pub async fn update_broadcast(
&self,
broadcast_id: &str,
name: &str,
description: &str,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<Broadcast>
[src]
&self,
broadcast_id: &str,
name: &str,
description: &str,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<Broadcast>
pub async fn push_to_broadcast(
&self,
broadcast_id: &str,
pgn: &str
) -> LichessResult<()>
[src]
&self,
broadcast_id: &str,
pgn: &str
) -> LichessResult<()>
impl Lichess
[src]
pub async fn challenge_create(
&self,
username: &str,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<EntityChallenge>
[src]
&self,
username: &str,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<EntityChallenge>
pub async fn challenge_accept(&self, challenge_id: &str) -> LichessResult<()>
[src]
pub async fn challenge_decline(&self, challenge_id: &str) -> LichessResult<()>
[src]
pub async fn challenge_cancel(&self, challenge_id: &str) -> LichessResult<()>
[src]
pub async fn challenge_stockfish(
&self,
level: u8,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<ChallengeGame>
[src]
&self,
level: u8,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<ChallengeGame>
pub async fn challenge_open(
&self,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<EntityChallenge>
[src]
&self,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<EntityChallenge>
pub async fn start_game_clocks(
&self,
game_id: &str,
token1: &str,
token2: &str
) -> LichessResult<()>
[src]
&self,
game_id: &str,
token1: &str,
token2: &str
) -> LichessResult<()>
pub async fn admin_challenge(
&self,
user1: &str,
user2: &str,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<EntityChallenge>
[src]
&self,
user1: &str,
user2: &str,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<EntityChallenge>
impl Lichess
[src]
pub async fn export_one_game_pgn(
&self,
game_id: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<String>
[src]
&self,
game_id: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<String>
pub async fn export_one_game_json(
&self,
game_id: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<Game>
[src]
&self,
game_id: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<Game>
pub async fn export_ongoing_game_pgn(
&self,
username: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<String>
[src]
&self,
username: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<String>
pub async fn export_ongoing_game_json(
&self,
username: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<Game>
[src]
&self,
username: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<Game>
pub async fn export_all_games_pgn(
&self,
username: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Bytes>>>
[src]
&self,
username: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Bytes>>>
pub async fn export_all_games_json(
&self,
username: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
[src]
&self,
username: &str,
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
pub async fn export_games_by_ids_json(
&self,
ids: &[&str],
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
[src]
&self,
ids: &[&str],
query_params: Option<&Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
pub async fn stream_current_games(
&self,
ids: &[&str]
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
[src]
&self,
ids: &[&str]
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
pub async fn get_ongoing_games(
&self,
nb_games: u8
) -> LichessResult<Vec<UserGame>>
[src]
&self,
nb_games: u8
) -> LichessResult<Vec<UserGame>>
pub async fn get_current_tv_games(&self) -> LichessResult<TVChannels>
[src]
pub async fn import_one_game(&self, pgn: &str) -> LichessResult<String>
[src]
impl Lichess
[src]
pub async fn get_current_simuls(&self) -> LichessResult<Simuls>
[src]
pub async fn study_chapter_pgn(
&self,
study_id: &str,
chapter_id: &str,
query_params: Option<&[(&str, &str)]>
) -> LichessResult<String>
[src]
&self,
study_id: &str,
chapter_id: &str,
query_params: Option<&[(&str, &str)]>
) -> LichessResult<String>
pub async fn study_full_pgn(
&self,
study_id: &str,
query_params: Option<&[(&str, &str)]>
) -> LichessResult<String>
[src]
&self,
study_id: &str,
query_params: Option<&[(&str, &str)]>
) -> LichessResult<String>
pub async fn mesage(&self, recipient: &str, message: &str) -> LichessResult<()>
[src]
pub async fn get_cloud_eval(
&self,
fen: &str,
multi_pv: u8,
variant: Option<&str>
) -> LichessResult<Eval>
[src]
&self,
fen: &str,
multi_pv: u8,
variant: Option<&str>
) -> LichessResult<Eval>
impl Lichess
[src]
pub async fn get_followings(
&self,
username: &str
) -> LichessResult<impl Stream<Item = LichessResult<User>>>
[src]
&self,
username: &str
) -> LichessResult<impl Stream<Item = LichessResult<User>>>
pub async fn get_followers(
&self,
username: &str
) -> LichessResult<impl Stream<Item = LichessResult<User>>>
[src]
&self,
username: &str
) -> LichessResult<impl Stream<Item = LichessResult<User>>>
impl Lichess
[src]
pub async fn swiss_new(
&self,
team_id: &str,
clock_time: u16,
clock_increment: u16,
nb_rounds: u16,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<SwissTournament>
[src]
&self,
team_id: &str,
clock_time: u16,
clock_increment: u16,
nb_rounds: u16,
form_params: Option<&[(&str, &str)]>
) -> LichessResult<SwissTournament>
pub async fn swiss_trf(&self, id: &str) -> LichessResult<String>
[src]
pub async fn games_by_swiss_pgn(
&self,
id: &str,
query_params: Option<Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Bytes>>>
[src]
&self,
id: &str,
query_params: Option<Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Bytes>>>
pub async fn games_by_swiss_json(
&self,
id: &str,
query_params: Option<Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
[src]
&self,
id: &str,
query_params: Option<Vec<(&str, &str)>>
) -> LichessResult<impl Stream<Item = LichessResult<Game>>>
pub async fn results_by_swiss(
&self,
id: &str,
nb_players: u16
) -> LichessResult<impl Stream<Item = LichessResult<PlayerStandings>>>
[src]
&self,
id: &str,
nb_players: u16
) -> LichessResult<impl Stream<Item = LichessResult<PlayerStandings>>>
impl Lichess
[src]
pub async fn get_team_swiss_tournaments(
&self,
team_id: &str,
max: u16
) -> LichessResult<impl Stream<Item = LichessResult<SwissTournament>>>
[src]
&self,
team_id: &str,
max: u16
) -> LichessResult<impl Stream<Item = LichessResult<SwissTournament>>>
pub async fn get_a_single_team(&self, team_id: &str) -> LichessResult<Team>
[src]
pub async fn get_popular_teams(
&self,
page: Option<u16>
) -> LichessResult<Vec<Team>>
[src]
&self,
page: Option<u16>
) -> LichessResult<Vec<Team>>
pub async fn teams_of_a_player(
&self,
username: &str
) -> LichessResult<Vec<Team>>
[src]
&self,
username: &str
) -> LichessResult<Vec<Team>>
pub async fn search_teams(
&self,
text: &str,
page: Option<u16>
) -> LichessResult<Vec<Team>>
[src]
&self,
text: &str,
page: Option<u16>
) -> LichessResult<Vec<Team>>
pub async fn get_team_arena_tournaments(
&self,
team_id: &str,
max: u16
) -> LichessResult<impl Stream<Item = LichessResult<ArenaTournament>>>
[src]
&self,
team_id: &str,
max: u16
) -> LichessResult<impl Stream<Item = LichessResult<ArenaTournament>>>
pub async fn join_a_team(
&self,
team_id: &str,
message: Option<&str>
) -> LichessResult<()>
[src]
&self,
team_id: &str,
message: Option<&str>
) -> LichessResult<()>
pub async fn leave_a_team(&self, team_id: &str) -> LichessResult<()>
[src]
pub async fn kick_user_from_team(
&self,
team_id: &str,
user_id: &str
) -> LichessResult<()>
[src]
&self,
team_id: &str,
user_id: &str
) -> LichessResult<()>
pub async fn message_all_members(
&self,
team_id: &str,
message: &str
) -> LichessResult<()>
[src]
&self,
team_id: &str,
message: &str
) -> LichessResult<()>
impl Lichess
[src]
pub async fn get_user_status(
&self,
ids: &[&str]
) -> LichessResult<Vec<LightUser>>
[src]
&self,
ids: &[&str]
) -> LichessResult<Vec<LightUser>>
pub async fn get_all_top_10(
&self
) -> LichessResult<HashMap<PerfType, Vec<LightUser>>>
[src]
&self
) -> LichessResult<HashMap<PerfType, Vec<LightUser>>>
pub async fn get_one_leaderboard(
&self,
nb: u8,
perf_type: PerfType
) -> LichessResult<Vec<LightUser>>
[src]
&self,
nb: u8,
perf_type: PerfType
) -> LichessResult<Vec<LightUser>>
pub async fn get_user_public(&self, username: &str) -> LichessResult<User>
[src]
pub async fn get_rating_history(
&self,
username: &str
) -> LichessResult<Vec<RatingHistory>>
[src]
&self,
username: &str
) -> LichessResult<Vec<RatingHistory>>
pub async fn get_my_puzzle_activity(
&self,
max: Option<u64>
) -> LichessResult<impl Stream<Item = LichessResult<PuzzleActivity>>>
[src]
&self,
max: Option<u64>
) -> LichessResult<impl Stream<Item = LichessResult<PuzzleActivity>>>
pub async fn get_users_by_ids(&self, ids: &[&str]) -> LichessResult<Vec<User>>
[src]
pub async fn get_members_of_a_team(
&self,
team_id: &str
) -> LichessResult<impl Stream<Item = LichessResult<User>>>
[src]
&self,
team_id: &str
) -> LichessResult<impl Stream<Item = LichessResult<User>>>
pub async fn get_live_streamers(&self) -> LichessResult<Vec<LightUser>>
[src]
pub async fn get_crosstable(
&self,
player: &str,
opponent: &str,
matchup: bool
) -> LichessResult<Crosstable>
[src]
&self,
player: &str,
opponent: &str,
matchup: bool
) -> LichessResult<Crosstable>
impl Lichess
[src]
pub fn default() -> Lichess
[src]
Create an unathenticaed instance of the client Even with endpoints what do not require QAuth, this will be imposed with constrints
pub fn new(pat: String) -> Lichess
[src]
Creates an authenticaed instance using the provided token
Auto Trait Implementations
impl !RefUnwindSafe for Lichess
[src]
impl Send for Lichess
[src]
impl Sync for Lichess
[src]
impl Unpin for Lichess
[src]
impl !UnwindSafe for Lichess
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,