Struct CratestackContext 

pub struct CratestackContext {
    pub auth: Option<CratestackAuthIdentity>,
    pub principal: Option<PrincipalContext>,
    pub extensions: BTreeMap<String, Value>,
    /* private fields */
}

Fields

auth: Option<CratestackAuthIdentity>

principal: Option<PrincipalContext>

extensions: BTreeMap<String, Value>

Implementations

impl CratestackContext

pub fn anonymous() -> CratestackContext

pub fn authenticated( fields: impl IntoIterator<Item = (String, Value)>, ) -> CratestackContext

pub fn is_authenticated(&self) -> bool

pub fn is_system(&self) -> bool

Backs the auth().isSystem() policy builtin. true only for a context minted through SystemContext; never true for anything an AuthProvider produced from a request, and never true after a deserialization round-trip. See the field doc on CratestackContext::system for the structural argument, not just the convention, behind that guarantee.

pub fn auth_field(&self, name: &str) -> Option<&Value>

pub fn from_principal<P>( principal: Option<P>, ) -> Result<CratestackContext, CratestackError>

where P: Serialize,

pub fn with_principal(principal: PrincipalContext) -> CratestackContext

pub fn principal_actor_id(&self) -> Option<&str>

Convenience accessor for the principal’s actor id. Falls back from principal.actor.id to principal.claims.id to auth.fields.id so audit rows capture an identity regardless of which builder the caller used.

pub fn tenant_id(&self) -> Option<&str>

Tenant id surfaced for audit/log scoping.

pub fn client_ip(&self) -> Option<&str>

Client IP, if the auth provider injected one (e.g. from X-Forwarded-For or the socket remote-addr).

pub fn request_id(&self) -> Option<&str>

W3C traceparent value, if surfaced into the context by the correlation-id middleware.

pub fn audit_claims_snapshot(&self) -> BTreeMap<String, Value>

Snapshot of principal claims for audit recording — full map regardless of nesting depth. Empty for anonymous contexts.

pub fn with_request_id(self, request_id: impl Into<String>) -> CratestackContext

Attach a W3C traceparent-style request id to the context. Surfaces in tracing spans and is recorded on audit events so SIEM tools can stitch the trail across systems.

pub fn with_client_ip(self, ip: impl Into<String>) -> CratestackContext

Attach a client IP for the same reasons as Self::with_request_id. Banks generally derive this from X-Forwarded-For or the socket address inside the auth provider.

Trait Implementations

impl AsRef<CratestackContext> for SystemContext

fn as_ref(&self) -> &CratestackContext

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CratestackContext

fn clone(&self) -> CratestackContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CratestackContext

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

Formats the value using the given formatter.

impl Default for CratestackContext

fn default() -> CratestackContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CratestackContext

fn deserialize<__D>( __deserializer: __D, ) -> Result<CratestackContext, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CratestackContext

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CratestackContext

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CratestackContext