Skip to main content

PullRequestsApi

Struct PullRequestsApi 

Source
pub struct PullRequestsApi<'a> { /* private fields */ }

Implementations§

Source§

impl<'a> PullRequestsApi<'a>

Source

pub async fn list( &self, repo: &RepoRef, filter: &PullRequestFilter, ) -> Result<Vec<PullRequest>>

GET /api/v1/repos/{repo_ref}/pullreq

Source

pub async fn get(&self, repo: &RepoRef, number: u64) -> Result<PullRequest>

GET /api/v1/repos/{repo_ref}/pullreq/{pullreq_number}

Source

pub async fn find_for_branch( &self, repo: &RepoRef, branch: &str, ) -> Result<Option<PullRequest>>

The open pull request whose source branch is branch, if there is one.

This is how gf pr view works with no number: the branch you are standing on identifies the pull request.

Source

pub async fn find_any_for_branch( &self, repo: &RepoRef, branch: &str, ) -> Result<Option<PullRequest>>

The most recent pull request from branch in any state — what a branch names once its pull request has been merged or closed.

Source

pub async fn create( &self, repo: &RepoRef, input: &CreatePullRequest, ) -> Result<PullRequest>

POST /api/v1/repos/{repo_ref}/pullreq

Source

pub async fn update( &self, repo: &RepoRef, number: u64, input: &UpdatePullRequest, ) -> Result<PullRequest>

PATCH /api/v1/repos/{repo_ref}/pullreq/{pullreq_number}

Source

pub async fn merge( &self, repo: &RepoRef, number: u64, input: &MergePullRequest, ) -> Result<MergeResult>

POST /api/v1/repos/{repo_ref}/pullreq/{pullreq_number}/merge

Source

pub async fn delete_source_branch( &self, repo: &RepoRef, number: u64, ) -> Result<()>

DELETE /api/v1/repos/{repo_ref}/pullreq/{pullreq_number}/branch

Separate from the merge call: GitFox has no delete_branch flag on merge, so gf pr merge --delete-branch is two requests.

Source

pub async fn diff_files( &self, repo: &RepoRef, number: u64, ) -> Result<Vec<FileDiff>>

GET …/pullreq/{pullreq_number}/diff as structured per-file entries.

The endpoint content-negotiates: JSON here, raw text in Self::diff_text. Both describe the same change.

Source

pub async fn diff_text(&self, repo: &RepoRef, number: u64) -> Result<String>

GET …/pullreq/{pullreq_number}/diff as a raw unified diff.

Source

pub async fn checks( &self, repo: &RepoRef, number: u64, ) -> Result<PullRequestChecks>

GET …/pullreq/{pullreq_number}/checks

Source

pub async fn commits( &self, repo: &RepoRef, number: u64, page: u32, limit: u32, ) -> Result<Vec<Commit>>

GET …/pullreq/{pullreq_number}/commits, oldest first.

Source

pub async fn set_state( &self, repo: &RepoRef, number: u64, state: PullRequestState, ) -> Result<PullRequest>

POST /api/v1/repos/{repo_ref}/pullreq/{pullreq_number}/state

Source

pub async fn set_draft( &self, repo: &RepoRef, number: u64, draft: bool, ) -> Result<PullRequest>

Mark an open pull request as a draft, or as ready for review.

The same endpoint as Self::set_state: GitFox treats “draft” as a facet of the open state rather than a state of its own.

Source

pub async fn activities( &self, repo: &RepoRef, number: u64, kinds: &[&str], ) -> Result<Vec<PullRequestActivity>>

GET …/pullreq/{pullreq_number}/activities, optionally only some kinds (comment, change-comment, system).

Source

pub async fn comment( &self, repo: &RepoRef, number: u64, text: &str, ) -> Result<PullRequestActivity>

POST …/pullreq/{pullreq_number}/comments

Source

pub async fn update_comment( &self, repo: &RepoRef, number: u64, comment_id: i64, text: &str, ) -> Result<PullRequestActivity>

PATCH …/comments/{pullreq_comment_id}

Source

pub async fn delete_comment( &self, repo: &RepoRef, number: u64, comment_id: i64, ) -> Result<()>

DELETE …/comments/{pullreq_comment_id}

Source

pub async fn review( &self, repo: &RepoRef, number: u64, commit_sha: &str, decision: ReviewDecision, ) -> Result<()>

POST …/pullreq/{pullreq_number}/reviews

A review is a decision about one commit; GitFox has no review body, so anything the reviewer wants to say is a separate comment.

Source

pub async fn reviewers( &self, repo: &RepoRef, number: u64, ) -> Result<Vec<PullRequestReviewer>>

GET …/pullreq/{pullreq_number}/reviewers

Source

pub async fn add_reviewer( &self, repo: &RepoRef, number: u64, reviewer_id: i64, ) -> Result<PullRequestReviewer>

PUT …/pullreq/{pullreq_number}/reviewers

Source

pub async fn remove_reviewer( &self, repo: &RepoRef, number: u64, reviewer_id: i64, ) -> Result<()>

DELETE …/pullreq/{pullreq_number}/reviewers/{pullreq_reviewer_id}

Source

pub async fn labels( &self, repo: &RepoRef, number: u64, ) -> Result<PullRequestLabels>

GET …/pullreq/{pullreq_number}/labels — every label that could be attached, each saying whether it is.

Source

pub async fn assign_label( &self, repo: &RepoRef, number: u64, label_id: i64, value_id: Option<i64>, value: Option<&str>, ) -> Result<()>

PUT …/pullreq/{pullreq_number}/labels

value names a value by text; GitFox creates it when the label allows new values. value_id picks an existing one.

Source

pub async fn unassign_label( &self, repo: &RepoRef, number: u64, label_id: i64, ) -> Result<()>

DELETE …/pullreq/{pullreq_number}/labels/{label_id}

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for PullRequestsApi<'a>

§

impl<'a> !UnwindSafe for PullRequestsApi<'a>

§

impl<'a> Forget for PullRequestsApi<'a>

§

impl<'a> Freeze for PullRequestsApi<'a>

§

impl<'a> Send for PullRequestsApi<'a>

§

impl<'a> Sync for PullRequestsApi<'a>

§

impl<'a> Unpin for PullRequestsApi<'a>

§

impl<'a> UnsafeUnpin for PullRequestsApi<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more