Skip to main content

OutstandingLogout

Struct OutstandingLogout 

Source
pub struct OutstandingLogout { /* private fields */ }
Expand description

A LogoutRequest the caller has already accepted.

Pass it to Saml<Sp>::finish_sso_with_outstanding_logout or Saml<Sp>::accept_unsolicited_sso_with_outstanding_logout. The library does not store it. NameID values must be equal. A Format on the logout must match; an omitted Format compares values only. An empty session list applies to every session of that principal. The classification is in docs/conformance/web-browser-sso-acceptance.md.

§Examples

use saml_rs::{NameId, NameIdFormat, OutstandingLogout, SamlInstant, SessionIndex};

let logout = OutstandingLogout::try_new(
    NameId::new(
        "alice@example.com",
        Some(NameIdFormat::EmailAddress),
    ),
    vec![SessionIndex::try_new("_session")?],
    SamlInstant::try_new("2026-10-06T00:00:00Z")?,
)?;

Implementations§

Source§

impl OutstandingLogout

Source

pub fn try_new( principal: NameId, sessions: Vec<SessionIndex>, not_on_or_after: SamlInstant, ) -> Result<OutstandingLogout, SamlError>

Create an outstanding logout from the principal, sessions, and NotOnOrAfter the caller accepted.

§Errors

Returns SamlError::Invalid when the principal value is empty or not_on_or_after is not a representable SAML UTC xs:dateTime.

Source

pub fn principal(&self) -> &NameId

Principal named by the accepted logout.

Source

pub fn sessions(&self) -> &[SessionIndex]

Sessions named by the accepted logout.

Empty means the logout carried no SessionIndex.

Source

pub fn not_on_or_after(&self) -> &SamlInstant

NotOnOrAfter from the accepted logout, normalized as a SAML UTC instant.

Trait Implementations§

Source§

impl Clone for OutstandingLogout

Source§

fn clone(&self) -> OutstandingLogout

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OutstandingLogout

Source§

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

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

impl Eq for OutstandingLogout

Source§

impl PartialEq for OutstandingLogout

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OutstandingLogout

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V