Struct GitHubAt 

pub struct GitHubAt<'a, R: ProcessRunner = JobRunner> { /* private fields */ }

A GitHub client with a working directory bound, so its repo-scoped methods drop the leading dir argument (gh.at(dir).pr_list()). Construct one with GitHub::at.

Implementations

impl<'a, R: ProcessRunner> GitHubAt<'a, R>

pub async fn version(&self) -> Result<String>

Bound form of GitHub’s version.

pub async fn capabilities(&self) -> Result<GitHubCapabilities>

Bound form of GitHub’s capabilities.

pub async fn auth_status(&self) -> Result<bool>

Bound form of GitHub’s auth_status.

pub async fn auth_status_for(&self, host: &GitHubHost) -> Result<bool>

Bound form of GitHub’s auth_status_for.

pub async fn api(&self, endpoint: &str) -> Result<String>

Bound form of GitHub’s api (with dir pre-bound).

pub async fn repo_view(&self) -> Result<RepoView>

Bound form of GitHub’s repo_view (with dir pre-bound).

pub async fn pr_list(&self) -> Result<Vec<PullRequest>>

Bound form of GitHub’s pr_list (with dir pre-bound).

pub async fn pr_list_with(&self, spec: PrList) -> Result<Vec<PullRequest>>

Bound form of GitHub’s pr_list_with (with dir pre-bound).

pub async fn pr_list_for_source_branch( &self, head: &str, ) -> Result<Vec<PullRequest>>

Bound form of GitHub’s pr_list_for_source_branch (with dir pre-bound).

pub async fn pr_list_for_branch( &self, head: &str, base: &str, ) -> Result<Vec<PullRequest>>

Bound form of GitHub’s pr_list_for_branch (with dir pre-bound).

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

Bound form of GitHub’s pr_view (with dir pre-bound).

pub async fn issue_list(&self) -> Result<Vec<Issue>>

Bound form of GitHub’s issue_list (with dir pre-bound).

pub async fn issue_list_with(&self, spec: IssueList) -> Result<Vec<Issue>>

Bound form of GitHub’s issue_list_with (with dir pre-bound).

pub async fn pr_create(&self, spec: PrCreate) -> Result<String>

Bound form of GitHub’s pr_create (with dir pre-bound).

pub async fn pr_add_labels(&self, number: u64, labels: &[String]) -> Result<()>

Bound form of GitHub’s pr_add_labels (with dir pre-bound).

pub async fn pr_remove_labels( &self, number: u64, labels: &[String], ) -> Result<()>

Bound form of GitHub’s pr_remove_labels (with dir pre-bound).

pub async fn pr_merge(&self, number: u64, merge: PrMerge) -> Result<()>

Bound form of GitHub’s pr_merge (with dir pre-bound).

pub async fn pr_mark_ready(&self, number: u64) -> Result<()>

Bound form of GitHub’s pr_mark_ready (with dir pre-bound).

pub async fn pr_close(&self, number: u64, spec: PrClose) -> Result<()>

Bound form of GitHub’s pr_close (with dir pre-bound).

pub async fn pr_checkout(&self, number: u64) -> Result<()>

Bound form of GitHub’s pr_checkout (with dir pre-bound).

pub async fn pr_checks(&self, number: u64) -> Result<Vec<CheckRun>>

Bound form of GitHub’s pr_checks (with dir pre-bound).

pub async fn pr_review(&self, number: u64, action: ReviewAction) -> Result<()>

Bound form of GitHub’s pr_review (with dir pre-bound).

pub async fn pr_comment(&self, number: u64, body: &str) -> Result<String>

Bound form of GitHub’s pr_comment (with dir pre-bound).

pub async fn pr_edit(&self, number: u64, edit: PrEdit) -> Result<()>

Bound form of GitHub’s pr_edit (with dir pre-bound).

pub async fn pr_feedback(&self, number: u64) -> Result<PrFeedback>

Bound form of GitHub’s pr_feedback (with dir pre-bound).

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

Bound form of GitHub’s pr_diff (with dir pre-bound).

pub async fn workflow_list(&self) -> Result<Vec<Workflow>>

Bound form of GitHub’s workflow_list (with dir pre-bound).

pub async fn workflow_list_with( &self, spec: WorkflowList, ) -> Result<Vec<Workflow>>

Bound form of GitHub’s workflow_list_with (with dir pre-bound).

pub async fn workflow_view(&self, selector: &str) -> Result<Workflow>

Bound form of GitHub’s workflow_view (with dir pre-bound).

pub async fn run_list( &self, limit: u64, branch: Option<String>, ) -> Result<Vec<WorkflowRun>>

Bound form of GitHub’s run_list (with dir pre-bound).

pub async fn run_view(&self, id: u64) -> Result<WorkflowRun>

Bound form of GitHub’s run_view (with dir pre-bound).

pub async fn run_watch(&self, id: u64) -> Result<WorkflowRun>

Bound form of GitHub’s run_watch (with dir pre-bound).

pub async fn workflow_dispatch(&self, spec: WorkflowDispatch) -> Result<()>

Bound form of GitHub’s workflow_dispatch (with dir pre-bound).

pub async fn run_rerun(&self, id: u64, scope: RerunScope) -> Result<()>

Bound form of GitHub’s run_rerun (with dir pre-bound).

pub async fn run_cancel(&self, id: u64) -> Result<()>

Bound form of GitHub’s run_cancel (with dir pre-bound).

pub async fn issue_create(&self, title: &str, body: &str) -> Result<String>

Bound form of GitHub’s issue_create (with dir pre-bound).

pub async fn issue_create_with(&self, spec: IssueCreate) -> Result<String>

Bound form of GitHub’s issue_create_with (with dir pre-bound).

pub async fn issue_add_labels( &self, number: u64, labels: &[String], ) -> Result<()>

Bound form of GitHub’s issue_add_labels (with dir pre-bound).

pub async fn issue_remove_labels( &self, number: u64, labels: &[String], ) -> Result<()>

Bound form of GitHub’s issue_remove_labels (with dir pre-bound).

pub async fn issue_view(&self, number: u64) -> Result<Issue>

Bound form of GitHub’s issue_view (with dir pre-bound).

pub async fn issue_close(&self, number: u64) -> Result<()>

Bound form of GitHub’s issue_close (with dir pre-bound).

pub async fn issue_reopen(&self, number: u64) -> Result<()>

Bound form of GitHub’s issue_reopen (with dir pre-bound).

pub async fn issue_comment(&self, number: u64, body: &str) -> Result<String>

Bound form of GitHub’s issue_comment (with dir pre-bound).

pub async fn release_list(&self) -> Result<Vec<Release>>

Bound form of GitHub’s release_list (with dir pre-bound).

pub async fn release_view(&self, tag: &str) -> Result<Release>

Bound form of GitHub’s release_view (with dir pre-bound).

pub async fn release_create(&self, spec: ReleaseCreate) -> Result<String>

Bound form of GitHub’s release_create (with dir pre-bound).

pub async fn release_delete(&self, tag: &str) -> Result<()>

Bound form of GitHub’s release_delete (with dir pre-bound).

pub async fn run(&self, args: &[String]) -> Result<String>

Bound form of GitHub’s run raw escape hatch — runs the given argv in the bound dir (forwards to the client’s run_in). For the process-cwd escape hatch, call run on GitHub directly.

pub async fn run_raw(&self, args: &[String]) -> Result<ProcessResult<String>>

Bound form of GitHub’s run_raw raw escape hatch — runs the given argv in the bound dir (forwards to the client’s run_raw_in). For the process-cwd escape hatch, call run_raw on GitHub directly.

pub async fn run_args(&self, args: &[&str]) -> Result<String>

Bound form of GitHub’s run_args raw escape hatch — runs the given argv in the bound dir (forwards to the client’s run_args_in). For the process-cwd escape hatch, call run_args on GitHub directly.

pub async fn run_raw_args(&self, args: &[&str]) -> Result<ProcessResult<String>>

Bound form of GitHub’s run_raw_args raw escape hatch — runs the given argv in the bound dir (forwards to the client’s run_raw_args_in). For the process-cwd escape hatch, call run_raw_args on GitHub directly.

Trait Implementations

impl<R: ProcessRunner> Clone for GitHubAt<'_, R>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: ProcessRunner> Copy for GitHubAt<'_, R>