Struct octocrab::pulls::ListPullRequestsBuilder

pub struct ListPullRequestsBuilder<'octo, 'b> { /* fields omitted */ }

A builder pattern struct for listing pull requests.

created by PullRequestHandler::list

Implementations

impl<'octo, 'b> ListPullRequestsBuilder<'octo, 'b>

pub fn state(self, state: State) -> Self

Filter pull requests by state.

pub fn head(self, head: impl Into<String>) -> Self

Filter pull requests by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocrab:test-branch.

pub fn base(self, base: impl Into<String>) -> Self

Filter pulls by base branch name. Example: gh-pages.

pub fn sort(self, sort: impl Into<Sort>) -> Self

What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).

pub fn direction(self, direction: impl Into<Direction>) -> Self

The direction of the sort. Can be either ascending or descending. Default: descending when sort is created or sort is not specified, otherwise ascending sort.

pub fn per_page(self, per_page: impl Into<u8>) -> Self

Results per page (max 100).

pub fn page(self, page: impl Into<u32>) -> Self

Page number of the results to fetch.

pub async fn send(self) -> Result<Page<PullRequest>>

Sends the actual request.

Trait Implementations

impl<'octo, 'b> Serialize for ListPullRequestsBuilder<'octo, 'b>

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

Serialize this value into the given Serde serializer.