Struct GitHubClient 

pub struct GitHubClient { /* private fields */ }

GitHub API client.

Implementations

impl GitHubClient

pub const DEFAULT_API_URL: &'static str = "https://api.github.com"

Default GitHub API URL.

pub fn new(auth: &Auth) -> Result<Self>

Create a new GitHub client.

Errors

Returns error if authentication fails.

pub fn with_base_url(auth: &Auth, base_url: impl Into<String>) -> Result<Self>

Create a new GitHub client with a custom API URL (for GitHub Enterprise).

Errors

Returns error if authentication fails.

pub async fn get_pr( &self, owner: &str, repo: &str, number: u64, ) -> Result<PullRequest>

Get a pull request by number.

Errors

Returns error if PR not found or API call fails.

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

Find a PR for a branch.

Errors

Returns error if API call fails.

pub async fn create_pr( &self, owner: &str, repo: &str, pr: CreatePullRequest, ) -> Result<PullRequest>

Create a pull request.

Errors

Returns error if PR creation fails.

pub async fn update_pr( &self, owner: &str, repo: &str, number: u64, update: UpdatePullRequest, ) -> Result<PullRequest>

Update a pull request.

Errors

Returns error if PR update fails.

pub async fn get_check_runs( &self, owner: &str, repo: &str, commit_sha: &str, ) -> Result<Vec<CheckRun>>

Get check runs for a commit.

Errors

Returns error if API call fails.

pub async fn merge_pr( &self, owner: &str, repo: &str, number: u64, merge: MergePullRequest, ) -> Result<MergeResult>

Merge a pull request.

Errors

Returns error if merge fails.

pub async fn delete_ref( &self, owner: &str, repo: &str, ref_name: &str, ) -> Result<()>

Delete a git reference (branch).

Errors

Returns error if deletion fails.

pub async fn list_pr_comments( &self, owner: &str, repo: &str, pr_number: u64, ) -> Result<Vec<IssueComment>>

List comments on a pull request.

Errors

Returns error if request fails.

pub async fn create_pr_comment( &self, owner: &str, repo: &str, pr_number: u64, comment: CreateComment, ) -> Result<IssueComment>

Create a comment on a pull request.

Errors

Returns error if request fails.

pub async fn update_pr_comment( &self, owner: &str, repo: &str, comment_id: u64, comment: UpdateComment, ) -> Result<IssueComment>

Update a comment on a pull request.

Errors

Returns error if request fails.

Trait Implementations

impl Debug for GitHubClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.