Struct octocrab::search::SearchHandler

pub struct SearchHandler<'octo> { /* fields omitted */ }

Handler for the search API.

Created with Octocrab::search.

Implementations

impl<'octo> SearchHandler<'octo>

pub fn repositories<'query>(
    self,
    query: &'query impl AsRef<str> + ?Sized
) -> QueryHandler<'octo, 'query, Repository>

Searches for all the repositories matching the search query.

let page = octocrab::instance()
    .search()
    .repositories("tetris language:rust")
    .sort("stars")
    .order("desc")
    .send()
    .await?;

pub fn commits<'query>(
    self,
    query: &'query impl AsRef<str> + ?Sized
) -> QueryHandler<'octo, 'query, Commit>

Searches for all the commits matching the search query.

let page = octocrab::instance()
    .search()
    .commits("hello world repo:XAMPPRocky/octocrab")
    .sort("author-date")
    .order("desc")
    .send()
    .await?;

pub fn users<'query>(
    self,
    query: &'query impl AsRef<str> + ?Sized
) -> QueryHandler<'octo, 'query, User>

Searches for all users matching the search query.

let page = octocrab::instance()
    .search()
    .users("bors type:user")
    .sort("followers")
    .order("desc")
    .send()
    .await?;

pub fn issues_and_pull_requests<'query>(
    self,
    query: &'query impl AsRef<str> + ?Sized
) -> QueryHandler<'octo, 'query, Issue>

Searches for all the issues matching the search query.

let page = octocrab::instance()
    .search()
    .issues_and_pull_requests("GitHub Octocrab in:readme user:ferris")
    .sort("comments")
    .order("asc")
    .send()
    .await?;

pub fn code<'query>(
    self,
    query: &'query impl AsRef<str> + ?Sized
) -> QueryHandler<'octo, 'query, Code>

Searches for all code matching the search query.

let page = octocrab::instance()
    .search()
    .code("println! language:rust repo:rust-lang/rust")
    .sort("indexed")
    .order("asc")
    .send()
    .await?;