Struct GitHubClient 

pub struct GitHubClient { /* private fields */ }

Implementations

impl GitHubClient

pub fn blame( &self, owner: &str, repo: &str, path: &str, ref_: Option<&str>, ) -> ProviderResult<Vec<BlameRange>>

Blame, derived client-side: GitHub’s GraphQL Blob.blame was removed from the schema (upstream drift, caught live 2026-08-28) and REST has none — so walk the file’s commit history newest-first and claim each commit’s ADDED hunks (the classic no-API approximation; intra-hunk moves and pre-window history are not distinguished). Bounded to COMMITS commit details — older lines carry no margin, honestly. Cached per (repo, path, ref) for the session.

impl GitHubClient

pub fn blob_at( &self, owner: &str, repo: &str, path: &str, ref_: Option<&str>, ) -> ProviderResult<(Vec<u8>, String)>

File at a ref via the contents API: raw bytes + the git blob sha (the provider’s content id).

pub fn source_tarball(&self, repo: &str) -> ProviderResult<Vec<u8>>

The default branch’s source as a gzip tarball (api.github.com 302s to codeload). Capped — a repo past this size is not a fallback candidate.

pub fn fetch_blob( &self, owner: &str, repo: &str, sha: &str, ) -> ProviderResult<Vec<u8>>

Fetch a blob by git sha, cache-first (blobs are immutable). Files over 1 MiB are rejected — too heavy for a preview pane.

impl GitHubClient

pub fn log( &self, owner: &str, repo: &str, path: Option<&str>, ref_: Option<&str>, limit: Option<usize>, ) -> ProviderResult<(Vec<LogEntry>, bool)>

Commit log newest-first. limit+1 probing decides truncated without parsing Link headers; a hard cap of 100 keeps it to one call (the spec’s ~N reading).

pub fn commit( &self, owner: &str, repo: &str, sha: &str, ) -> ProviderResult<CommitResponse>

v1.6 (plans/0028 M1): one commit’s detail — message, parents, changed files with their unified hunks. The wire model is types::CommitResponse; the seam mapping lives in lib.rs.

impl GitHubClient

pub fn refs(&self, owner: &str, repo: &str) -> ProviderResult<RepoRefs>

Branches (first 100) + tags (first 100); the repo’s default branch is marked. Refs past the cap are out of scope for a switcher.

impl GitHubClient

pub fn search(&self, query: &str) -> ProviderResult<Vec<SearchItem>>

Repo search + org search, merged: orgs first, then repos. Returns provider-level items (the trait boundary type).

Examples found in repository

examples/ping.rs (line 9)

fn main() {
    let client = rootle_github::client::GitHubClient::new();
    println!("anonymous: {}", client.is_anonymous());

    let t0 = std::time::Instant::now();
    match client.search("ratatui") {
        Ok(items) => println!("search ok in {:?}: {} items", t0.elapsed(), items.len()),
        Err(e) => println!("search ERR in {:?}: {e}", t0.elapsed()),
    }

    let t1 = std::time::Instant::now();
    match client.org_repos("ratatui") {
        Ok(repos) => println!("org ok in {:?}: {} repos", t1.elapsed(), repos.len()),
        Err(e) => println!("org ERR in {:?}: {e}", t1.elapsed()),
    }
}

pub fn org_repos(&self, org: &str) -> ProviderResult<Vec<RepoInfo>>

Examples found in repository

examples/ping.rs (line 15)

fn main() {
    let client = rootle_github::client::GitHubClient::new();
    println!("anonymous: {}", client.is_anonymous());

    let t0 = std::time::Instant::now();
    match client.search("ratatui") {
        Ok(items) => println!("search ok in {:?}: {} items", t0.elapsed(), items.len()),
        Err(e) => println!("search ERR in {:?}: {e}", t0.elapsed()),
    }

    let t1 = std::time::Instant::now();
    match client.org_repos("ratatui") {
        Ok(repos) => println!("org ok in {:?}: {} repos", t1.elapsed(), repos.len()),
        Err(e) => println!("org ERR in {:?}: {e}", t1.elapsed()),
    }
}

pub fn search_code(&self, q: &str) -> ProviderResult<(Vec<CodeItem>, bool)>

Code search (plans/0002 §4). Requires auth — anonymous clients get a clear error. q is the full query string including qualifiers (repo:, org:, extension:, path:); text-match fragments are requested for previews.

pub fn search_code_page( &self, q: &str, page: u32, ) -> ProviderResult<(Vec<CodeItem>, u64)>

One page of code search (per_page=100, 1-indexed pages). Returns (items, total_count) — total drives truncated and the progressive page loop (v1.3, plans/0011).

impl GitHubClient

pub fn fetch_tree( &self, owner: &str, repo: &str, ref_: Option<&str>, ) -> ProviderResult<(TreeResponse, bool, String)>

Fetch a repo’s full recursive tree with the sha-keyed cache (PLAN.md §8): revalidate the branch ref with If-None-Match (304 = free, tree unchanged), cache tree bodies by their sha. Also returns the default branch (URL building, yank). v1.5: ref_ pins another branch/tag/sha — the tree endpoint takes any ref, and a sha’s tree is immutable, so the same etag revalidation is correct there.

impl GitHubClient

pub fn new() -> Self

Examples found in repository

examples/ping.rs (line 5)

fn main() {
    let client = rootle_github::client::GitHubClient::new();
    println!("anonymous: {}", client.is_anonymous());

    let t0 = std::time::Instant::now();
    match client.search("ratatui") {
        Ok(items) => println!("search ok in {:?}: {} items", t0.elapsed(), items.len()),
        Err(e) => println!("search ERR in {:?}: {e}", t0.elapsed()),
    }

    let t1 = std::time::Instant::now();
    match client.org_repos("ratatui") {
        Ok(repos) => println!("org ok in {:?}: {} repos", t1.elapsed(), repos.len()),
        Err(e) => println!("org ERR in {:?}: {e}", t1.elapsed()),
    }
}

pub fn anonymous() -> Self

No environment or credential process; useful for anonymous browsing.

pub fn is_anonymous(&self) -> bool

Examples found in repository

examples/ping.rs (line 6)

fn main() {
    let client = rootle_github::client::GitHubClient::new();
    println!("anonymous: {}", client.is_anonymous());

    let t0 = std::time::Instant::now();
    match client.search("ratatui") {
        Ok(items) => println!("search ok in {:?}: {} items", t0.elapsed(), items.len()),
        Err(e) => println!("search ERR in {:?}: {e}", t0.elapsed()),
    }

    let t1 = std::time::Instant::now();
    match client.org_repos("ratatui") {
        Ok(repos) => println!("org ok in {:?}: {} repos", t1.elapsed(), repos.len()),
        Err(e) => println!("org ERR in {:?}: {e}", t1.elapsed()),
    }
}

Trait Implementations

impl Default for GitHubClient

fn default() -> Self

Returns the “default value” for a type.