Struct Principal 

#[non_exhaustive]
pub struct Principal {
    pub user_id: Uuid,
    pub subject: String,
    pub email: Option<String>,
    pub name: Option<String>,
    pub roles: Vec<String>,
}

The authenticated caller.

user_id is the local User row every caller has (ADR-0021 § 3); subject is who the provider says it is. roles decide #[require_role]; rules that depend on data take the principal in their params and decide in the use case.

#[non_exhaustive]: built with Principal::new and the with_* methods, so a new field later breaks no one.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_id: Uuid

subject: String

email: Option<String>

name: Option<String>

roles: Vec<String>

Implementations

impl Principal

pub fn new(user_id: Uuid, subject: impl Into<String>) -> Self

pub fn with_user_id(self, user_id: Uuid) -> Self

pub fn with_email(self, email: impl Into<String>) -> Self

pub fn with_name(self, name: impl Into<String>) -> Self

pub fn with_roles<I, S>(self, roles: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

pub fn has_role(&self, role: &str) -> bool

Whether the caller holds role — compared exactly, as the provider or the roles column spells it.

Trait Implementations

impl Clone for Principal

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Principal

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

Formats the value using the given formatter.

impl Eq for Principal

impl PartialEq for Principal

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Principal