Struct GithubUpdateBuilder 

pub struct GithubUpdateBuilder<'a, E = DefaultEmbedder> { /* private fields */ }

Configures and runs a GitHub tree-API sync. Created by LinkIndex::update_github.

Implementations

impl<'a, E: Embedder> GithubUpdateBuilder<'a, E>

pub fn token(self, token: impl Into<String>) -> Self

A GitHub token (PAT). Sent as Bearer to the API and raw hosts only — never to any host a document happens to link to. Required for private and internal repositories; anonymous works for public ones.

pub fn bases( self, api_base: impl Into<CompactString>, raw_base: impl Into<CompactString>, ) -> Self

Override the API and raw base URLs (GitHub Enterprise, tests).

pub fn depth(self, depth: u16) -> Self

Cap directory levels below the subdir (0 = only files directly in it).

pub fn max_bytes(self, max_bytes: u64) -> Self

Per-file byte ceiling; oversized files are skipped without a fetch.

pub fn concurrency(self, concurrency: usize) -> Self

Maximum blob fetches in flight at once.

pub fn embed_batch(self, n: usize) -> Self

Set how many pages are embedded per model call (default 64).

pub fn pin(self) -> Self

Pin every file indexed by this sync (exempt from eviction).

pub fn accept_extension(self, extension: impl AsRef<str>) -> Self

Only index files whose path ends with extension (additive).

pub fn validators( self, entries: impl IntoIterator<Item = (UrlKey, CompactString)>, ) -> Self

Known blob SHAs from a persistent backend (keyed by canonical raw-URL key). Same precedence as UpdateBuilder::validators: the in-memory index’s own ETags win on conflict; these exist for the stateless case, where a fresh index syncs a repository the backend already knows.

pub async fn run(self) -> Result<UpdateReport>

Run the sync: list the tree (one request), fetch only new/changed blobs, index them, and report unchanged files as revalidated.

Errors

Returns an error if the tree cannot be listed (bad spec, auth, a truncated listing) or a page cannot be embedded; per-file fetch failures are counted, not propagated.

Trait Implementations

impl<E> Debug for GithubUpdateBuilder<'_, E>

Available on crate feature github only.

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

Formats the value using the given formatter.