Skip to main content

GitHubApi

rung_github

Trait GitHubApi 

Source 
pub trait GitHubApi: Send + Sync {
    // Required methods
    fn get_pr(
        &self,
        owner: &str,
        repo: &str,
        number: u64,
    ) -> impl Future<Output = Result<PullRequest>> + Send;
    fn get_prs_batch(
        &self,
        owner: &str,
        repo: &str,
        numbers: &[u64],
    ) -> impl Future<Output = Result<HashMap<u64, PullRequest>>> + Send;
    fn find_pr_for_branch(
        &self,
        owner: &str,
        repo: &str,
        branch: &str,
    ) -> impl Future<Output = Result<Option<PullRequest>>> + Send;
    fn create_pr(
        &self,
        owner: &str,
        repo: &str,
        pr: CreatePullRequest,
    ) -> impl Future<Output = Result<PullRequest>> + Send;
    fn update_pr(
        &self,
        owner: &str,
        repo: &str,
        number: u64,
        update: UpdatePullRequest,
    ) -> impl Future<Output = Result<PullRequest>> + Send;
    fn get_check_runs(
        &self,
        owner: &str,
        repo: &str,
        commit_sha: &str,
    ) -> impl Future<Output = Result<Vec<CheckRun>>> + Send;
    fn merge_pr(
        &self,
        owner: &str,
        repo: &str,
        number: u64,
        merge: MergePullRequest,
    ) -> impl Future<Output = Result<MergeResult>> + Send;
    fn delete_ref(
        &self,
        owner: &str,
        repo: &str,
        ref_name: &str,
    ) -> impl Future<Output = Result<()>> + Send;
    fn get_default_branch(
        &self,
        owner: &str,
        repo: &str,
    ) -> impl Future<Output = Result<String>> + Send;
    fn list_pr_comments(
        &self,
        owner: &str,
        repo: &str,
        pr_number: u64,
    ) -> impl Future<Output = Result<Vec<IssueComment>>> + Send;
    fn create_pr_comment(
        &self,
        owner: &str,
        repo: &str,
        pr_number: u64,
        comment: CreateComment,
    ) -> impl Future<Output = Result<IssueComment>> + Send;
    fn update_pr_comment(
        &self,
        owner: &str,
        repo: &str,
        comment_id: u64,
        comment: UpdateComment,
    ) -> impl Future<Output = Result<IssueComment>> + Send;
}
Expand description

Trait for GitHub API operations.

This trait abstracts GitHub API calls, allowing for:

  • Dependency injection in commands/services
  • Mock implementations for testing
  • Alternative implementations (e.g., offline mode, caching)

All methods take owner and repo as parameters to support operations across different repositories.

Required Methods§

Source

fn get_pr( &self, owner: &str, repo: &str, number: u64, ) -> impl Future<Output = Result<PullRequest>> + Send

Get a pull request by number.

Source

fn get_prs_batch( &self, owner: &str, repo: &str, numbers: &[u64], ) -> impl Future<Output = Result<HashMap<u64, PullRequest>>> + Send

Get multiple pull requests by number (batch operation).

Returns a map of PR number to PR data. Missing PRs are omitted.

Source

fn find_pr_for_branch( &self, owner: &str, repo: &str, branch: &str, ) -> impl Future<Output = Result<Option<PullRequest>>> + Send

Find a PR for a branch.

Returns None if no open PR exists for the branch.

Source

fn create_pr( &self, owner: &str, repo: &str, pr: CreatePullRequest, ) -> impl Future<Output = Result<PullRequest>> + Send

Create a pull request.

Source

fn update_pr( &self, owner: &str, repo: &str, number: u64, update: UpdatePullRequest, ) -> impl Future<Output = Result<PullRequest>> + Send

Update a pull request.

Source

fn get_check_runs( &self, owner: &str, repo: &str, commit_sha: &str, ) -> impl Future<Output = Result<Vec<CheckRun>>> + Send

Get check runs for a commit.

Source

fn merge_pr( &self, owner: &str, repo: &str, number: u64, merge: MergePullRequest, ) -> impl Future<Output = Result<MergeResult>> + Send

Merge a pull request.

Source

fn delete_ref( &self, owner: &str, repo: &str, ref_name: &str, ) -> impl Future<Output = Result<()>> + Send

Delete a git reference (branch).

Source

fn get_default_branch( &self, owner: &str, repo: &str, ) -> impl Future<Output = Result<String>> + Send

Get the repository’s default branch name.

Source

fn list_pr_comments( &self, owner: &str, repo: &str, pr_number: u64, ) -> impl Future<Output = Result<Vec<IssueComment>>> + Send

List comments on a pull request.

Source

fn create_pr_comment( &self, owner: &str, repo: &str, pr_number: u64, comment: CreateComment, ) -> impl Future<Output = Result<IssueComment>> + Send

Create a comment on a pull request.

Source

fn update_pr_comment( &self, owner: &str, repo: &str, comment_id: u64, comment: UpdateComment, ) -> impl Future<Output = Result<IssueComment>> + Send

Update a comment on a pull request.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§