Struct PyxTokenStore 

pub struct PyxTokenStore { /* private fields */ }

Implementations

impl PyxTokenStore

pub fn from_settings() -> Result<Self, TokenStoreError>

Create a new PyxTokenStore from settings.

pub fn root(&self) -> &Path

Return the root directory for the token store.

pub fn api(&self) -> &DisplaySafeUrl

Return the API URL for the token store.

pub async fn access_token( &self, client: &ClientWithMiddleware, tolerance_secs: u64, ) -> Result<Option<AccessToken>, TokenStoreError>

Get or initialize an AccessToken from the store.

If an access token is set in the environment, it will be returned as-is.

If an access token is present on-disk, it will be returned (and refreshed, if necessary).

If no access token is found, but an API key is present, the API key will be used to bootstrap an access token.

pub async fn init( &self, client: &ClientWithMiddleware, tolerance_secs: u64, ) -> Result<Option<PyxTokens>, TokenStoreError>

Initialize the PyxTokens from the store.

If an access token is already present, it will be returned (and refreshed, if necessary).

If no access token is found, but an API key is present, the API key will be used to bootstrap an access token.

pub async fn write(&self, tokens: &PyxTokens) -> Result<(), TokenStoreError>

Write the tokens to the store.

pub fn has_auth_token(&self) -> bool

Returns true if the user appears to have an authentication token set.

pub fn has_api_key(&self) -> bool

Returns true if the user appears to have an API key set.

pub fn has_oauth_tokens(&self) -> bool

Returns true if the user appears to have OAuth tokens stored on disk.

pub fn has_credentials(&self) -> bool

Returns true if the user appears to have credentials (which may be invalid).

pub async fn read(&self) -> Result<Option<PyxTokens>, TokenStoreError>

Read the tokens from the store.

pub async fn delete(&self) -> Result<(), Error>

Remove the tokens from the store.

pub fn is_known_url(&self, url: &Url) -> bool

Returns true if the given URL is “known” to this token store (i.e., should be authenticated using the store’s tokens).

pub fn is_known_domain(&self, url: &Url) -> bool

Returns true if the URL is on a “known” domain (i.e., the same domain as the API or CDN).

Like is_known_url, but also returns true if the API is on the subdomain of the URL (e.g., if the API is api.pyx.dev and the URL is pyx.dev).

Trait Implementations

impl Clone for PyxTokenStore

fn clone(&self) -> PyxTokenStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyxTokenStore

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

Formats the value using the given formatter.