Struct GitHubClient 

pub struct GitHubClient { /* private fields */ }

GitHub API client wrapper that encapsulates Octocrab.

Provides clean API without exposing Octocrab dependency. Cloning is cheap (Arc clone).

Implementations

impl GitHubClient

pub fn builder() -> GitHubClientBuilder

Create a new client builder

pub fn with_token(token: impl Into<String>) -> GitHubResult<Self>

Convenience: create client with personal access token

pub fn inner(&self) -> &Arc<Octocrab>

Get inner Octocrab client

pub fn get_issue( &self, owner: impl Into<String>, repo: impl Into<String>, issue_number: u64, ) -> AsyncTask<Result<Issue, GitHubError>>

Get a single issue

pub fn create_issue( &self, owner: impl Into<String>, repo: impl Into<String>, title: impl Into<String>, body: Option<String>, assignees: Option<Vec<String>>, labels: Option<Vec<String>>, ) -> AsyncTask<Result<Issue, GitHubError>>

Create a new issue

pub fn add_issue_comment( &self, owner: impl Into<String>, repo: impl Into<String>, issue_number: u64, body: impl Into<String>, ) -> AsyncTask<Result<Comment, GitHubError>>

Add a comment to an issue

pub fn get_issue_comments( &self, owner: impl Into<String>, repo: impl Into<String>, issue_number: u64, ) -> AsyncStream<Result<Comment, GitHubError>>

Get comments for an issue

pub fn list_issues( &self, request: ListIssuesRequest, ) -> AsyncStream<Result<Issue, GitHubError>>

List issues with filters

pub fn update_issue( &self, request: UpdateIssueRequest, ) -> AsyncTask<Result<Issue, GitHubError>>

Update an issue

pub fn search_issues( &self, query: impl Into<String>, sort: Option<String>, order: Option<String>, page: Option<u32>, per_page: Option<u8>, ) -> AsyncStream<Result<Issue, GitHubError>>

Search issues

pub fn create_pull_request( &self, request: CreatePullRequestRequest, ) -> AsyncTask<Result<PullRequest, GitHubError>>

Create a pull request

pub fn get_pull_request_status( &self, owner: impl Into<String>, repo: impl Into<String>, pr_number: u64, ) -> AsyncTask<Result<CombinedStatus, GitHubError>>

Get pull request status

pub fn get_pull_request_comments( &self, owner: impl Into<String>, repo: impl Into<String>, pr_number: u64, ) -> AsyncStream<Result<Comment, GitHubError>>

Get pull request comments

pub fn get_pull_request_files( &self, owner: impl Into<String>, repo: impl Into<String>, pr_number: u64, ) -> AsyncStream<Result<DiffEntry, GitHubError>>

Get pull request files

pub fn get_pull_request_reviews( &self, owner: impl Into<String>, repo: impl Into<String>, pr_number: u64, ) -> AsyncStream<Result<Review, GitHubError>>

Get pull request reviews

pub fn create_pull_request_review( &self, owner: impl Into<String>, repo: impl Into<String>, pr_number: u64, options: CreatePullRequestReviewOptions, ) -> AsyncTask<Result<Review, GitHubError>>

Create a pull request review

pub fn add_pull_request_review_comment( &self, request: AddPullRequestReviewCommentRequest, ) -> AsyncTask<Result<ReviewComment, GitHubError>>

Add a review comment to a pull request

pub fn update_pull_request( &self, owner: impl Into<String>, repo: impl Into<String>, pr_number: u64, options: UpdatePullRequestOptions, ) -> AsyncTask<Result<PullRequest, GitHubError>>

Update a pull request

pub fn merge_pull_request( &self, owner: impl Into<String>, repo: impl Into<String>, pr_number: u64, options: MergePullRequestOptions, ) -> AsyncTask<Result<Value, GitHubError>>

Merge a pull request

pub fn get_file_contents( &self, owner: impl Into<String>, repo: impl Into<String>, path: impl Into<String>, ref_name: Option<String>, ) -> AsyncTask<Result<Vec<Content>, GitHubError>>

Get file contents

pub fn create_or_update_file( &self, request: CreateOrUpdateFileRequest, ) -> AsyncTask<Result<FileUpdate, GitHubError>>

Create or update a file

pub fn list_branches( &self, owner: impl Into<String>, repo: impl Into<String>, page: Option<u32>, per_page: Option<u8>, ) -> AsyncTask<Result<Vec<Branch>, GitHubError>>

List branches

pub fn create_branch( &self, owner: impl Into<String>, repo: impl Into<String>, branch_name: impl Into<String>, sha: impl Into<String>, ) -> AsyncTask<Result<Ref, GitHubError>>

Create a branch

pub fn list_commits( &self, owner: impl Into<String>, repo: impl Into<String>, options: ListCommitsOptions, ) -> AsyncTask<Result<Vec<RepoCommit>, GitHubError>>

List commits

pub fn get_commit( &self, owner: impl Into<String>, repo: impl Into<String>, commit_sha: impl Into<String>, page: Option<u32>, per_page: Option<u8>, ) -> AsyncTask<Result<RepoCommit, GitHubError>>

Get a commit

pub fn search_code( &self, query: impl Into<String>, sort: Option<String>, order: Option<String>, page: Option<u32>, per_page: Option<u8>, enrich_stars: bool, ) -> AsyncTask<Result<Page<Code>, GitHubError>>

Search code

pub fn create_repository( &self, name: impl Into<String>, description: Option<String>, private: Option<bool>, auto_init: Option<bool>, ) -> AsyncTask<Result<Repository, GitHubError>>

Create a repository

pub fn fork_repository( &self, owner: impl Into<String>, repo: impl Into<String>, organization: Option<String>, ) -> AsyncTask<Result<Repository, GitHubError>>

Fork a repository

pub fn push_files( &self, owner: impl Into<String>, repo: impl Into<String>, branch: impl Into<String>, files: HashMap<String, String>, commit_message: impl Into<String>, ) -> AsyncTask<Result<Commit, GitHubError>>

Push files to a repository

pub fn get_me(&self) -> AsyncTask<Result<Author, GitHubError>>

Get the authenticated user

pub fn search_users( &self, query: impl Into<String>, sort: Option<UserSearchSort>, order: Option<SearchOrder>, page: Option<u32>, per_page: Option<u8>, ) -> AsyncTask<Result<Page<Author>, GitHubError>>

Search users

pub fn list_code_scanning_alerts( &self, owner: impl Into<String>, repo: impl Into<String>, state: Option<String>, ref_name: Option<String>, tool_name: Option<String>, severity: Option<String>, ) -> AsyncTask<Result<Vec<Value>, GitHubError>>

List code scanning alerts

pub fn get_code_scanning_alert( &self, owner: impl Into<String>, repo: impl Into<String>, alert_number: u64, ) -> AsyncTask<Result<Value, GitHubError>>

Get a code scanning alert

pub fn list_secret_scanning_alerts( &self, owner: impl Into<String>, repo: impl Into<String>, state: Option<String>, secret_type: Option<String>, resolution: Option<String>, ) -> AsyncTask<Result<Vec<SecretScanningAlert>, GitHubError>>

List secret scanning alerts

pub fn get_secret_scanning_alert( &self, owner: impl Into<String>, repo: impl Into<String>, alert_number: u32, ) -> AsyncTask<Result<SecretScanningAlert, GitHubError>>

Get a secret scanning alert

pub async fn upload_release_asset( &self, owner: impl Into<String>, repo: impl Into<String>, options: UploadAssetOptions, ) -> Result<Asset, GitHubError>

Upload an asset to a release

Requires the release ID and binary content of the file. Returns the uploaded asset information including download URL.

pub async fn delete_release_asset( &self, owner: impl Into<String>, repo: impl Into<String>, asset_id: u64, ) -> Result<(), GitHubError>

Delete a release asset

pub fn request_copilot_review( &self, owner: impl Into<String>, repo: impl Into<String>, pr_number: u64, ) -> AsyncTask<Result<(), GitHubError>>

Request a Copilot review

Trait Implementations

impl Clone for GitHubClient

fn clone(&self) -> GitHubClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitHubClient

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

Formats the value using the given formatter.