Struct PolicyContext 

pub struct PolicyContext {
    pub session: Session,
    pub user_id: Option<String>,
    pub roles: Vec<String>,
    pub pool: Option<Pool<AsyncPgConnection>>,
    pub policy_registry: PolicyRegistry,
}

Per-request context handed to every policy and scope check.

Carries the resolved Session, the authenticated user id (when present), the active role set, the PolicyRegistry (so Post::scope(&ctx) can resolve a registered scope without re-threading state), and a clone of the database pool so policies can consult related rows. Clone + Send + Sync — flows freely across .await points.

Fields

session: Session

The full per-request Session. Read raw values via Session::get when a policy needs data beyond the canonical user-id and role keys.

user_id: Option<String>

The authenticated user id, if any. Mirrors the configured session auth key (default: "user_id").

roles: Vec<String>

Active role set for the current user. Empty when the user has no role or is anonymous.

pool: Option<Pool<AsyncPgConnection>>

Database connection pool, cloned from AppState. Policies that need to consult related rows (e.g. group membership) can borrow a connection here.

policy_registry: PolicyRegistry

Registered Policy / Scope map, cloned from AppState. Lets the Scoped blanket trait resolve a registered scope from &ctx alone — the Post::scope(&ctx).load(&mut db).await? ergonomic the authorization guide documents.

Implementations

impl PolicyContext

pub async fn from_session(session: &Session, auth_session_key: &str) -> Self

Build a PolicyContext from a session alone.

The resulting context has an empty PolicyRegistry and no pool — sufficient for hand-rolled policy unit tests that don’t go through AppState. Production code paths construct a PolicyContext via from_request instead.

pub async fn from_request(state: &AppState, session: &Session) -> Self

Build a fully-populated PolicyContext from AppState + Session. Used by the #[authorize] macro and #[repository(policy = ...)]-generated handlers.

pub const fn is_authenticated(&self) -> bool

Returns true when the request has a resolved authenticated user.

pub fn user_id_i64(&self) -> Option<i64>

Returns the user id parsed as an i64, when the session stored it as a numeric string. Convenient for the common case of BIGSERIAL primary keys.

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

Returns true when the active role set contains role.

pub fn has_any_role<I, S>(&self, candidates: I) -> bool

where I: IntoIterator<Item = S>, S: AsRef<str>,

Returns true when the active role set contains any of the supplied roles. Mirrors #[secured("a", "b")] semantics.

pub fn with_pool(self, pool: Pool<AsyncPgConnection>) -> Self

Attach a database pool to the context. Used by the framework when constructing the context inside extractors; tests can also call this to inject a pool by hand.

Trait Implementations

impl Clone for PolicyContext

fn clone(&self) -> PolicyContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.