Struct LogoutRequest 

pub struct LogoutRequest {
    pub session_id: SessionId,
    pub family_id: SessionFamilyId,
    pub scope: LogoutScope,
}

Input required to revoke an existing session.

Higher-level adapters and services populate this value from the currently authenticated session context.

Examples

use webgates_sessions::logout::{LogoutRequest, LogoutScope};
use webgates_sessions::session::{SessionFamilyId, SessionId};

let session_id = SessionId::new();
let family_id = SessionFamilyId::new();

// Revoke only the current session.
let request = LogoutRequest::new(session_id, family_id, LogoutScope::CurrentSession);
assert_eq!(request.scope, LogoutScope::CurrentSession);

// Revoke the entire session family (all devices).
let request = LogoutRequest::new(session_id, family_id, LogoutScope::SessionFamily);
assert_eq!(request.scope, LogoutScope::SessionFamily);

Fields

session_id: SessionId

The session targeted by the logout operation.

family_id: SessionFamilyId

The family that owns the targeted session.

scope: LogoutScope

The revocation scope to apply.

Implementations

impl LogoutRequest

pub fn new( session_id: SessionId, family_id: SessionFamilyId, scope: LogoutScope, ) -> Self

Creates a new logout request.

Trait Implementations

impl Clone for LogoutRequest

fn clone(&self) -> LogoutRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogoutRequest

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

Formats the value using the given formatter.

impl Hash for LogoutRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LogoutRequest

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

impl StructuralPartialEq for LogoutRequest