Struct GithubAuth 

pub struct GithubAuth { /* private fields */ }

Bearer auth confined to GitHub’s two content hosts.

crate::StaticTokenAuth::bearer_scoped covers one host, but a GitHub sync talks to exactly two — the API host for the tree listing and the raw host for blob content — and the token must reach both while never leaking anywhere else (a crawled markdown file can link off-host; the fetch of that link must be anonymous).

Implementations

impl GithubAuth

pub fn new(token: Option<String>) -> Self

Auth for github.com. token = a PAT (works for public, private, and internal repositories — raw.githubusercontent.com accepts Bearer); None = anonymous, public repositories only.

pub fn with_hosts( self, api_host: impl Into<CompactString>, raw_host: impl Into<CompactString>, ) -> Self

Override the trusted hosts (GitHub Enterprise).

Trait Implementations

impl AuthProvider for GithubAuth

type RefreshFuture<'a> = Ready<Result<(), Error>>

The future returned by AuthProvider::refresh. Static providers use std::future::Ready; OAuth uses its token-exchange future.

fn credential(&self, resource: &Resource) -> Credential<'_>

The credential to apply to a request for resource. Synchronous and lock-free — this is the per-fetch hot path.

fn refresh(&self) -> Self::RefreshFuture<'_>

Refresh an expiring credential. Static providers return a ready no-op.

fn needs_refresh(&self) -> bool

Whether the cached credential is missing or near expiry. Default: never.

impl Debug for GithubAuth

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

Formats the value using the given formatter.