modo-rs 0.8.0

Rust web framework for small monolithic apps
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

use serde::{Deserialize, Serialize};

/// Normalized user profile returned after a successful OAuth exchange.
///
/// Fields common to all providers are promoted to top-level fields. The raw JSON response from the
/// provider is preserved in [`raw`](UserProfile::raw) for any provider-specific data your
/// application needs.
#[non_exhaustive]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UserProfile {
    /// Lowercase provider identifier (`"google"`, `"github"`, …).
    pub provider: String,
    /// The user's unique ID within the provider's system.
    pub provider_user_id: String,
    /// Primary email address.
    pub email: String,
    /// Whether the provider has verified this email address.
    pub email_verified: bool,
    /// Display name, if the provider returned one.
    pub name: Option<String>,
    /// URL of the user's avatar image, if available.
    pub avatar_url: Option<String>,
    /// Raw JSON response from the provider's user-info endpoint.
    pub raw: serde_json::Value,
}

impl UserProfile {
    /// Create a new user profile with required fields.
    pub fn new(
        provider: impl Into<String>,
        provider_user_id: impl Into<String>,
        email: impl Into<String>,
    ) -> Self {
        Self {
            provider: provider.into(),
            provider_user_id: provider_user_id.into(),
            email: email.into(),
            email_verified: false,
            name: None,
            avatar_url: None,
            raw: serde_json::Value::Null,
        }
    }
}