Struct roctogen::endpoints::search::SearchCommitsParams

pub struct SearchCommitsParams<'req> { /* fields omitted */ }

Query parameters for the Search commits endpoint.

Implementations

impl<'req> SearchCommitsParams<'req>

pub fn new() -> Self

pub fn q(self, q: &'req str) -> Self

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.

pub fn sort(self, sort: &'req str) -> Self

Sorts the results of your query by author-date or committer-date. Default: best match

pub fn order(self, order: &'req str) -> Self

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

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

Results per page (max 100).

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

Page number of the results to fetch.

Trait Implementations

impl<'req> Default for SearchCommitsParams<'req>

fn default() -> SearchCommitsParams<'req>

Returns the “default value” for a type.

impl<'enc> From<&'enc PerPage> for SearchCommitsParams<'enc>

fn from(per_page: &'enc PerPage) -> Self

Performs the conversion.

impl<'req> Serialize for SearchCommitsParams<'req>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.