Struct StaticTokenAuth 

pub struct StaticTokenAuth { /* private fields */ }

An AuthProvider holding one fixed secret credential.

A credential may be host-scoped (StaticTokenAuth::bearer_scoped): it is then sent only to that host (or its subdomains), so a page that links to a foreign host reached via an in-scope crawl can never exfiltrate the token.

Implementations

impl StaticTokenAuth

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

Authorization: Bearer <token>, sent to any host.

Prefer StaticTokenAuth::bearer_scoped for private crawls so the token is confined to the intended host.

pub fn bearer_scoped( token: impl Into<String>, host: impl Into<CompactString>, ) -> Self

Authorization: Bearer <token>, sent only to host and its subdomains.

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

A GitHub personal access token (sent as a bearer token, which the GitHub REST API accepts).

pub fn header(name: &'static str, token: impl Into<String>) -> Self

A custom header credential, e.g. x-api-key: <token>.

Trait Implementations

impl AuthProvider for StaticTokenAuth

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 StaticTokenAuth

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

Formats the value using the given formatter.