Struct SessionContext 

pub struct SessionContext {
    pub actor: Option<SessionActor>,
    pub correlation_id: Option<String>,
    pub client: SessionClientContext,
    pub attributes: BTreeMap<String, String>,
}

Immutable metadata describing the caller and environment for a session operation.

This type is transport-agnostic by design. Adapters may derive values from HTTP requests, RPC metadata, CLI invocations, or background jobs before passing them into session services.

Examples

use webgates_sessions::context::{SessionActor, SessionClientContext, SessionContext};

let context = SessionContext::new()
    .with_actor(SessionActor::Subject {
        subject_id: "user-42".to_string(),
    })
    .with_correlation_id("req-abc-123")
    .with_client(
        SessionClientContext::new()
            .with_ip_address("203.0.113.5")
            .with_user_agent("MyApp/2.0"),
    )
    .with_attribute("entrypoint", "login");

assert!(!context.is_empty());

Fields

actor: Option<SessionActor>

Stable identifier for the logical actor that initiated the operation.

correlation_id: Option<String>

Correlation identifier used to trace a session workflow across layers.

client: SessionClientContext

Client environment metadata collected at the boundary.

attributes: BTreeMap<String, String>

Additional non-sensitive attributes associated with the operation.

Implementations

impl SessionContext

pub fn new() -> Self

Creates an empty context with no actor or client metadata.

pub fn with_actor(self, actor: SessionActor) -> Self

Sets the actor that initiated the session operation.

pub fn with_correlation_id(self, correlation_id: impl Into<String>) -> Self

Sets the correlation identifier for the current workflow.

pub fn with_client(self, client: SessionClientContext) -> Self

Replaces the client metadata associated with the current workflow.

pub fn with_attribute( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Inserts a single non-sensitive attribute into the context.

pub fn is_empty(&self) -> bool

Returns true when the context contains no actor, correlation id, client metadata, or attributes.

Trait Implementations

impl Clone for SessionContext

fn clone(&self) -> SessionContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionContext

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

Formats the value using the given formatter.

impl Default for SessionContext

fn default() -> SessionContext

Returns the “default value” for a type.

impl PartialEq for SessionContext

fn eq(&self, other: &SessionContext) -> 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 Eq for SessionContext

impl StructuralPartialEq for SessionContext