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
impl CoolContext
pub fn anonymous() -> CoolContext
pub fn authenticated( fields: impl IntoIterator<Item = (String, Value)>, ) -> CoolContext
pub fn is_authenticated(&self) -> bool
pub fn auth_field(&self, name: &str) -> Option<&Value>
pub fn from_principal<P>(principal: Option<P>) -> Result<CoolContext, CoolError>where
P: Serialize,
pub fn with_principal(principal: PrincipalContext) -> CoolContext
Sourcepub fn principal_actor_id(&self) -> Option<&str>
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.
Sourcepub fn client_ip(&self) -> Option<&str>
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).
Sourcepub fn request_id(&self) -> Option<&str>
pub fn request_id(&self) -> Option<&str>
W3C traceparent value, if surfaced into the context by the
correlation-id middleware.
Sourcepub fn audit_claims_snapshot(&self) -> BTreeMap<String, Value>
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.
Sourcepub fn with_request_id(self, request_id: impl Into<String>) -> CoolContext
pub fn with_request_id(self, request_id: impl Into<String>) -> CoolContext
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.
Sourcepub fn with_client_ip(self, ip: impl Into<String>) -> CoolContext
pub fn with_client_ip(self, ip: impl Into<String>) -> CoolContext
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
impl Clone for CoolContext
Source§fn clone(&self) -> CoolContext
fn clone(&self) -> CoolContext
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CoolContext
impl Debug for CoolContext
Source§impl Default for CoolContext
impl Default for CoolContext
Source§fn default() -> CoolContext
fn default() -> CoolContext
Source§impl<'de> Deserialize<'de> for CoolContext
impl<'de> Deserialize<'de> for CoolContext
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<CoolContext, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<CoolContext, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for CoolContext
impl PartialEq for CoolContext
Source§fn eq(&self, other: &CoolContext) -> bool
fn eq(&self, other: &CoolContext) -> bool
self and other values to be equal, and is used by ==.Source§impl Serialize for CoolContext
impl Serialize for CoolContext
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for CoolContext
Auto Trait Implementations§
impl Freeze for CoolContext
impl RefUnwindSafe for CoolContext
impl Send for CoolContext
impl Sync for CoolContext
impl Unpin for CoolContext
impl UnsafeUnpin for CoolContext
impl UnwindSafe for CoolContext
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);