Skip to main content

CoolContext

Struct CoolContext 

Source
pub struct CoolContext {
    pub auth: Option<CoolAuthIdentity>,
    pub principal: Option<PrincipalContext>,
    pub extensions: BTreeMap<String, Value>,
}

Fields§

§auth: Option<CoolAuthIdentity>§principal: Option<PrincipalContext>§extensions: BTreeMap<String, Value>

Implementations§

Source§

impl CoolContext

Source

pub fn anonymous() -> Self

Source

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

Source

pub fn is_authenticated(&self) -> bool

Source

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

Source

pub fn from_principal<P: Serialize>( principal: Option<P>, ) -> Result<Self, CoolError>

Source

pub fn with_principal(principal: PrincipalContext) -> Self

Source

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.

Source

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

Tenant id surfaced for audit/log scoping.

Source

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).

Source

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

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

Source

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.

Source

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

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.

Source

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

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§

Source§

impl Clone for CoolContext

Source§

fn clone(&self) -> CoolContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoolContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CoolContext

Source§

fn default() -> CoolContext

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CoolContext

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CoolContext

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for CoolContext

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CoolContext

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,