Struct use_github_api::users::Users

#[non_exhaustive]
pub struct Users<'a> { /* fields omitted */ }

Implementations

impl<'a> Users<'a>

pub async fn list(
    &self,
    cfg: Option<Params>
) -> Result<Vec<User>, Box<dyn Error>>

Fetches a list of users.

pub async fn user(&self, username: &str) -> Result<User, Box<dyn Error>>

Fetches a specific user. If authenticated, it will show a few more fields. If the current authenticated user is the same as the user being fetched, a few more fields will exist.

Errors

Will error if the user does not exist.

pub async fn contextual_info(
    &self,
    username: &str,
    cfg: Option<Params>
) -> Result<User, Box<dyn Error>>

This is supported on crate feature auth only.

Fetches contextual info (like the hovercard you see on github). Requires auth. It can either work with the username alone (and then it will fetch profile data), or it can work with a subject type (like “repository”) and id (the repository’s id on the API).

Errors

Will error if the user doesn’t exist.