Enum CFContestCommand

Source
pub enum CFContestCommand {
    Hacks {
        contest_id: i64,
    },
    List {
        gym: Option<bool>,
    },
    RatingChanges {
        contest_id: i64,
    },
    Standings {
        contest_id: i64,
        from: Option<i64>,
        count: Option<i64>,
        handles: Option<Vec<String>>,
        room: Option<i64>,
        show_unofficial: Option<bool>,
    },
    Status {
        contest_id: i64,
        handle: Option<String>,
        from: Option<i64>,
        count: Option<i64>,
    },
}
Expand description

Wrapper enum for all API methods of form contest.<method>.

More details for the contest command can be found here.

Variants§

§

Hacks

Struct for sending contest.hacks requests to the Codeforces API.

Returns list of hacks in the specified contest. Full information about hacks is available only after some time after the contest end. During the contest, a user can see only their own hacks.

If correctly parsed, the response object will be of type responses::CFResult::CFHackVec.

More details for the contest.hacks command can be found here.

§Examples

let x = CFContestCommand::Hacks {
    contest_id: 1485,
};

match x.get(api_key, api_secret) {
    Ok(CFResult::CFHackVec(v)) => {
        // your code here
    },
    _ => {
        panic!("API request failed");
    }
}

Fields

§contest_id: i64

contestId of a contest (can be seen in the url of a contest, eg. /contest/1485).

§

List

Struct for sending contest.list requests to the Codeforces API.

Returns information about all available contests.

If correctly parsed, the response object will be of type responses::CFResult::CFContestVec.

More details for the contest.list command can be found here.

§Examples

let x = CFContestCommand::List {
    gym: Some(false),
};

match x.get(api_key, api_secret) {
    Ok(CFResult::CFContestVec(v)) => {
        // your code here
    },
    _ => {
        panic!("API request failed");
    }
}

Fields

§gym: Option<bool>

If Some(true), then gym contests are returned. Otherwise, regular contests are returned.

§

RatingChanges

Struct for sending contest.ratingChanges requests to the Codeforces API.

Returns rating changes after a specified contest.

If correctly parsed, the response object will be of type responses::CFResult::CFRatingChangeVec.

More details for the contest.ratingChanges command can be found here.

§Examples

let x = CFContestCommand::RatingChanges {
    contest_id: 1485,
};

match x.get(api_key, api_secret) {
    Ok(CFResult::CFRatingChangeVec(v)) => {
        // your code here
    },
    _ => {
        panic!("API request failed");
    }
}

Fields

§contest_id: i64

contestId of a contest (can be seen in the url of a contest, eg. /contest/1485).

§

Standings

Struct for sending contest.standings requests to the Codeforces API.

Returns a description of a specified contest as well as the requested part of the standings.

If correctly parsed, the response object will be of type responses::CFResult::CFContestStandings.

More details for the contest.standings command can be found here.

§Examples

let x = CFContestCommand::Standings {
    contest_id: 1485,
    from: Some(1),
    count: Some(3),
    handles: Some(vec!["thud".to_string()]),
    room: None,
    show_unofficial: Some(false),
};

match x.get(api_key, api_secret) {
    Ok(CFResult::CFContestStandings(s)) => {
        // your code here
    },
    _ => {
        panic!("API request failed");
    }
}

Fields

§contest_id: i64

contestId of a contest (can be seen in the url of a contest, eg. /contest/1485).

§from: Option<i64>

1-based index of the standings row to start the ranklist (most recent first).

§count: Option<i64>

Number of standing rows to return.

§handles: Option<Vec<String>>

Vec of handles. No more than 10000 handles is allowed by Codeforces.

§room: Option<i64>

If specified, then only participants from this room will be shown in the result. If not, all the participants will be shown.

§show_unofficial: Option<bool>

If true, then all participants (virtual, out of competition) are shown. Otherwise, only official contestants are shown.

§

Status

Struct for sending contest.status requests to the Codeforces API.

Returns submissions for specified contest. Optionally can return submissions of specified user.

If correctly parsed, the response object will be of type responses::CFResult::CFSubmissionVec.

More details for the contest.status command can be found here.

§Examples

let x = CFContestCommand::Status {
    contest_id: 1485,
    handle: None,
    from: Some(1),
    count: Some(3),
};

match x.get(api_key, api_secret) {
    Ok(CFResult::CFSubmissionVec(v)) => {
        // your code here
    },
    _ => {
        panic!("API request failed");
    }
}

Fields

§contest_id: i64

contestId of a contest (can be seen in the url of a contest, eg. /contest/1485).

§handle: Option<String>

If specified, then only this user’s submissions are returned.

§from: Option<i64>

1-based index of the standings row to start the ranklist (most recent first).

§count: Option<i64>

Number of submissions to return.

Trait Implementations§

Source§

impl CFAPIRequestable for CFContestCommand

Source§

fn query_params(&self) -> Vec<(&'static str, String)>

Method which returns a Vec of pairs (key, val) which will be mapped onto URL query parameters. Used internally and not much use for most people.
Source§

fn method_name(&self) -> &'static str

Method which returns a str slice of the method name (eg. “user.info”). Used internally and not much use for most people.
Source§

fn get(&self, api_key: &str, api_secret: &str) -> Result<CFResult, Error>

Fetch response from Codeforces servers. Read more
Source§

fn get_raw(&self, api_key: &str, api_secret: &str) -> Result<String, Error>

Fetch raw JSON response from Codeforces servers. Read more
Source§

impl Clone for CFContestCommand

Source§

fn clone(&self) -> CFContestCommand

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CFContestCommand

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CFContestCommand

Source§

fn eq(&self, other: &CFContestCommand) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for CFContestCommand

Source§

impl StructuralPartialEq for CFContestCommand

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,