Struct SessionClientContext 

pub struct SessionClientContext {
    pub user_agent: Option<String>,
    pub ip_address: Option<String>,
    pub device_id: Option<String>,
}

Client-origin metadata captured at a trust boundary.

Fields are optional because not every adapter or runtime can provide every value safely or reliably.

Examples

use webgates_sessions::context::SessionClientContext;

let client = SessionClientContext::new()
    .with_ip_address("203.0.113.5")
    .with_user_agent("MyApp/2.0")
    .with_device_id("device-abc");

assert!(!client.is_empty());
assert_eq!(client.ip_address.as_deref(), Some("203.0.113.5"));

Fields

user_agent: Option<String>

User agent or equivalent client identifier.

ip_address: Option<String>

Source IP address recorded as text to avoid transport-specific types.

device_id: Option<String>

Stable device identifier when the outer system provides one.

Implementations

impl SessionClientContext

pub fn new() -> Self

Creates an empty client context.

pub fn with_user_agent(self, user_agent: impl Into<String>) -> Self

Sets the user agent value.

pub fn with_ip_address(self, ip_address: impl Into<String>) -> Self

Sets the source IP address.

pub fn with_device_id(self, device_id: impl Into<String>) -> Self

Sets the stable device identifier.

pub fn is_empty(&self) -> bool

Returns true when no client metadata is present.

Trait Implementations

impl Clone for SessionClientContext

fn clone(&self) -> SessionClientContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionClientContext

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

Formats the value using the given formatter.

impl Default for SessionClientContext

fn default() -> SessionClientContext

Returns the “default value” for a type.

impl PartialEq for SessionClientContext

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

impl StructuralPartialEq for SessionClientContext