uv-auth 0.0.97

This is an internal component crate of uv
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

use std::io;
use std::sync::Arc;

use thiserror::Error;
use tokio::sync::OnceCell;
use tokio::task::JoinError;

use crate::Credentials;

/// A failure to read credentials or run the credential prompt.
#[derive(Debug, Error)]
pub enum CredentialsPromptError {
    #[error("Failed to read username")]
    ReadUsername(#[source] io::Error),
    #[error("Failed to read password")]
    ReadPassword(#[source] io::Error),
    #[error("Credential prompt task failed")]
    Task(#[from] JoinError),
}

/// An optional prompt for credentials after other authentication sources are exhausted.
///
/// Use this for a client dedicated to a single destination. Clones share the response so retries
/// reuse the entered credentials, even if the first request fails.
#[derive(Debug, Clone)]
pub struct CredentialsPrompt {
    callback: fn() -> Result<Option<Credentials>, CredentialsPromptError>,
    credentials: Arc<OnceCell<Option<Credentials>>>,
}

impl CredentialsPrompt {
    /// Create a prompt whose callback returns `None` when interactive input is unavailable.
    pub fn new(callback: fn() -> Result<Option<Credentials>, CredentialsPromptError>) -> Self {
        Self {
            callback,
            credentials: Arc::new(OnceCell::new()),
        }
    }

    /// Return credentials already entered through this prompt, without prompting.
    pub fn credentials(&self) -> Option<&Credentials> {
        self.credentials.get().and_then(Option::as_ref)
    }

    /// Return whether a prompt was attempted but interactive input was unavailable.
    pub fn was_unavailable(&self) -> bool {
        self.credentials.get().is_some_and(Option::is_none)
    }

    /// Prompt on a blocking thread, retaining the response for subsequent requests.
    pub async fn prompt(&self) -> Result<Option<Credentials>, CredentialsPromptError> {
        self.credentials
            .get_or_try_init(|| async { tokio::task::spawn_blocking(self.callback).await? })
            .await
            .cloned()
    }
}