Skip to main content

UserGamesRequest

Struct UserGamesRequest 

Source
pub struct UserGamesRequest<'a> { /* private fields */ }
Expand description

Builder for exporting a user’s games (GET /api/games/user/{username}).

Implementations§

Source§

impl<'a> UserGamesRequest<'a>

Source

pub fn max(self, count: u32) -> Self

Limits the number of games downloaded.

Source

pub fn since(self, timestamp: i64) -> Self

Only games played since this timestamp (Unix milliseconds).

Source

pub fn until(self, timestamp: i64) -> Self

Only games played until this timestamp (Unix milliseconds).

Source

pub fn vs(self, opponent: &'a str) -> Self

Only games played against this opponent.

Source

pub fn rated(self, rated: bool) -> Self

Only rated (true) or casual (false) games.

Source

pub fn perf_type(self, perf_type: &'a str) -> Self

Only games in these speeds/variants (comma-separated perf types).

Source

pub fn color(self, color: &'a str) -> Self

Only games played as this color ("white" or "black").

Source

pub fn analysed(self, analysed: bool) -> Self

Only games with (true) or without (false) computer analysis.

Source

pub fn ongoing(self, ongoing: bool) -> Self

Only currently-ongoing games.

Source

pub fn finished(self, finished: bool) -> Self

Include finished games (true); set false to get only ongoing games.

Source

pub fn last_fen(self, value: bool) -> Self

Include the X-FEN of each game’s last position (NDJSON only).

Source

pub fn with_bookmarked(self, value: bool) -> Self

Add a bookmarked flag on games the caller has bookmarked (NDJSON only).

Source

pub fn sort(self, sort: GameSort) -> Self

Sort order (defaults to most-recent-first).

Source

pub fn export(self, options: GameExportOptions) -> Self

Sets the shared export-format options (moves, clocks, evals, …).

Source

pub async fn stream(self) -> Result<BoxStream<'static, Result<LichessGame>>>

Executes the export, streaming games as decoded JSON values.

Source

pub async fn pgn(self) -> Result<String>

Executes the export, returning all games as one PGN string.

Trait Implementations§

Source§

impl<'a> Debug for UserGamesRequest<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for UserGamesRequest<'a>

§

impl<'a> !UnwindSafe for UserGamesRequest<'a>

§

impl<'a> Freeze for UserGamesRequest<'a>

§

impl<'a> Send for UserGamesRequest<'a>

§

impl<'a> Sync for UserGamesRequest<'a>

§

impl<'a> Unpin for UserGamesRequest<'a>

§

impl<'a> UnsafeUnpin for UserGamesRequest<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more