Struct GitHubApi

pub struct GitHubApi { /* private fields */ }

Implementations

impl GitHubApi

Implement basic functionality.

pub fn new(username: &str, password: &str) -> Self

Examples found in repository

examples/get_rate_limit.rs (line 15)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    let result = gh.get_rate_limit();
    println!("{:#?}", result);
}

examples/get_tags.rs (line 15)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    for page in gh.get_tags("postgres", "postgres") {
        println!("{:#?}", page);
    }
}

examples/get_license.rs (line 15)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    let license = gh.get_license("sous-chefs", "postgresql");
    println!("{:#?}", license);
}

examples/get_releases.rs (line 15)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    for page in gh.get_releases("sous-chefs", "postgresql") {
        println!("{:#?}", page);
    }
}

examples/get_license_as_json_string.rs (line 15)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    let license = gh.get_license("sous-chefs", "postgresql");
    println!("{:#?}", license.unwrap().result.to_json_string());
}

examples/get_releases_or_tags.rs (line 15)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    let owner = "rabbitmq";
    let repository = "rabbitmq-server";

    let releases_paginator = gh.get_releases(owner, repository);

    match releases_paginator.has_items() {
        Ok(true) => {
            println!("There are releases. Get them.");

            // for page in releases_paginator {
            //     println!("{:#?}", page);
            // }
        }

        Ok(false) => {
            println!("There are no releases. Get the tags instead.");

            // for page in gh.get_tags(owner, repository) {
            //     println!("{:#?}", page);
            // }
        }

        Err(error) => {
            println!("There was a problem: {:#?}.", error);
        }
    }
}

impl GitHubApi

Implement rate limits.

pub fn get_rate_limit( &self, ) -> Result<GitHubApiResult<RateLimitResponse>, GitHubApiError>

Gets rate limit information.

Examples found in repository

examples/get_rate_limit.rs (line 17)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    let result = gh.get_rate_limit();
    println!("{:#?}", result);
}

impl GitHubApi

pub fn get_license( &self, owner: &str, repository: &str, ) -> Result<GitHubApiResult<LicenseResponse>, GitHubApiError>

Gets the page.

Examples found in repository

examples/get_license.rs (line 17)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    let license = gh.get_license("sous-chefs", "postgresql");
    println!("{:#?}", license);
}

examples/get_license_as_json_string.rs (line 17)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    let license = gh.get_license("sous-chefs", "postgresql");
    println!("{:#?}", license.unwrap().result.to_json_string());
}

impl GitHubApi

pub fn get_tags_page( &self, owner: &str, repository: &str, page: u64, ) -> Result<GitHubApiResult<Vec<TagsResponse>>, GitHubApiError>

Gets a single page.

pub fn get_tags(&self, owner: &str, repository: &str) -> TagPaginator<'_>

Creates a paginator.

Examples found in repository

examples/get_tags.rs (line 17)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    for page in gh.get_tags("postgres", "postgres") {
        println!("{:#?}", page);
    }
}

impl GitHubApi

pub fn get_releases_page( &self, owner: &str, repository: &str, page: u64, ) -> Result<GitHubApiResult<Vec<ReleasesResponse>>, GitHubApiError>

Gets a single page.

pub fn get_releases( &self, owner: &str, repository: &str, ) -> ReleasePaginator<'_>

Creates a paginator.

Examples found in repository

examples/get_releases.rs (line 17)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    for page in gh.get_releases("sous-chefs", "postgresql") {
        println!("{:#?}", page);
    }
}

examples/get_releases_or_tags.rs (line 20)

fn main() {
    let username = env::var("GH_USER").expect("GH_USER not defined.");
    let password = env::var("GH_PASS").expect("GH_PASS not defined.");

    let gh = GitHubApi::new(&username, &password);

    let owner = "rabbitmq";
    let repository = "rabbitmq-server";

    let releases_paginator = gh.get_releases(owner, repository);

    match releases_paginator.has_items() {
        Ok(true) => {
            println!("There are releases. Get them.");

            // for page in releases_paginator {
            //     println!("{:#?}", page);
            // }
        }

        Ok(false) => {
            println!("There are no releases. Get the tags instead.");

            // for page in gh.get_tags(owner, repository) {
            //     println!("{:#?}", page);
            // }
        }

        Err(error) => {
            println!("There was a problem: {:#?}.", error);
        }
    }
}