Struct github_stats::search::Search

pub struct Search { /* fields omitted */ }

Uses Github's search API.

Example

Get merged PRs

use github_stats::{Query, Search};

let query = Query::new()
    .repo("rust-lang", "rust")
    .is("pr")
    .is("merged");

let results = Search::issues(&query)
    .per_page(10)
    .page(1)
    .search("<my user agent>")
    .await;

match results {
    Ok(results) => { /* do stuff */ }
    Err(e) => eprintln!(":("),
}

Implementations

impl Search

pub fn issues(query: &Query) -> Self

pub fn users(query: &Query) -> Self

pub fn get_query(&self) -> &str

Gets the query that will be used for the search.

pub fn per_page(self, per_page: usize) -> Self

Defaults to 10.

pub fn page(self, page: usize) -> Self

Defaults to 1.

pub fn next_page(&mut self)

Moves one page forward.

pub fn prev_page(&mut self)

Moves one page backward.

pub async fn search<'_, '_>(
    &'_ self,
    user_agent: &'_ str
) -> Result<SearchResults>

Runs the search.

Trait Implementations

impl Display for Search

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

Formats the value using the given formatter.