Enum codeforces_api::requests::CFUserCommand

pub enum CFUserCommand {
    BlogEntries {
        handle: String,
    },
    Friends {
        only_online: Option<bool>,
    },
    Info {
        handles: Vec<String>,
    },
    RatedList {
        active_only: Option<bool>,
    },
    Rating {
        handle: String,
    },
    Status {
        handle: String,
        from: Option<i64>,
        count: Option<i64>,
    },
}

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

More details for the user command can be found here.

Variants

BlogEntries

Struct for sending user.blogEntries requests to the Codeforces API.

Returns a list with all of a specified user's blog entries.

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

More details for the user.blogEntries command can be found here.

Examples

let x = CFUserCommand::BlogEntries {
    handle: "thud".to_string(),
};
 
match x.get(api_key, api_secret) {
    Ok(CFResult::CFBlogEntryVec(v)) => {
        // your code here
    },
    _ => {
        panic!("API request failed");
    }
}

Fields of BlogEntries

handle: String

Codeforces handle of the user for which to fetch blog entries.

Friends

Struct for sending user.friends requests to the Codeforces API.

Returns authorized user's friends (ie. the friends of the user who owns the API keys in use).

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

More details for the user.friends command can be found here.

Examples

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

Fields of Friends

only_online: Option<bool>

If Some(true), then only online friends are returned. Otherwise all friends are returned.

Info

Struct for sending user.info requests to the Codeforces API.

Returns information about one or several users.

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

More details for the user.info command can be found here.

Examples

let x = CFUserCommand::Info {
    handles: vec!["thud".to_string()],
};
 
match x.get(api_key, api_secret) {
    Ok(CFResult::CFUserVec(v)) => {
        // your code here
    },
    _ => {
        panic!("API request failed");
    }
}

Fields of Info

handles: Vec<String>

Vec of handles for which to get info for. Codeforces will return an error if this is empty.

RatedList

Struct for sending user.ratedList requests to the Codeforces API.

Returns the list of users who have participated in at least one rated contest.

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

More details for the user.ratedList command can be found here.

Examples

let x = CFUserCommand::RatedList {
    active_only: Some(true),
};
 
match x.get(api_key, api_secret) {
    Ok(CFResult::CFUserVec(v)) => {
        // your code here
    },
    _ => {
        panic!("API request failed");
    }
}

Fields of RatedList

active_only: Option<bool>

If Some(true), then only users who have participated in a rated contest during the last month are returned.

Rating

Struct for sending user.rating requests to the Codeforces API.

Returns the rating history of a specified user.

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

More details for the user.rating command can be found here.

Examples

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

Fields of Rating

handle: String

Codeforces handle of user for which to fetch rating changes for.

Status

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

Returns the submissions of a specified user.

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

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

Examples

let x = CFUserCommand::Status {
    handle: "thud".to_string(),
    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 of Status

handle: String

Codeforces handle of user for which to fetch submissions.

from: Option<i64>

Optional 1-based index of the first submission to return (most recent first).

count: Option<i64>

Optional number of submissions to return.

Trait Implementations

impl CFAPIRequestable for CFUserCommand

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.

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.

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

Fetch response from Codeforces servers.

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

Fetch raw JSON response from Codeforces servers.

impl Clone for CFUserCommand

fn clone(&self) -> CFUserCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CFUserCommand

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

Formats the value using the given formatter.

impl Eq for CFUserCommand

impl PartialEq<CFUserCommand> for CFUserCommand

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for CFUserCommand

impl StructuralPartialEq for CFUserCommand