Struct Pending 

pub struct Pending<Message>
where
    Message: PendingMessage,
{ /* private fields */ }

Pending SAML message correlation state.

Implementations

impl<Message> Pending<Message>

where Message: PendingMessage,

pub fn with_issue_instant(self, issued_at: SamlInstant) -> Pending<Message>

Record an issue instant.

pub fn with_expiration(self, expires_at: SamlInstant) -> Pending<Message>

Record an expiration instant.

pub fn id(&self) -> &MessageId

SAML protocol message ID.

pub fn relay_state(&self) -> &RelayStateParam

RelayState state.

pub fn peer_entity_id(&self) -> &EntityId

Peer entity ID.

pub fn issued_at(&self) -> Option<&SamlInstant>

Issue instant, if recorded.

pub fn expires_at(&self) -> Option<&SamlInstant>

Expiration instant, if recorded.

impl Pending<AuthnRequest>

pub fn try_new( request_id: MessageId, relay_state: RelayStateParam, acs: AcsEndpoint, response_binding: SsoResponseBinding, idp_entity_id: EntityId, ) -> Result<Pending<AuthnRequest>, SamlError>

Create pending AuthnRequest state without storing keys or metadata.

Errors

Returns SamlError::Invalid when the RelayState state is malformed, the IdP entity ID is empty, or the selected ACS binding does not match the expected response binding.

pub fn with_request_binding( self, request_binding: SsoRequestBinding, ) -> Pending<AuthnRequest>

Record the outbound AuthnRequest binding selected for dispatch.

pub fn from_snapshot( snapshot: PendingSnapshot<AuthnRequest>, ) -> Result<Pending<AuthnRequest>, SamlError>

Reconstruct pending AuthnRequest state from a snapshot.

Errors

Returns SamlError when any snapshot field is malformed or inconsistent.

Examples

use saml_rs::{AuthnRequest, Pending, PendingSnapshot, RelayStateParam};

let snapshot = PendingSnapshot::<AuthnRequest>::authn_request(
    "_request123",
    RelayStateParam::absent(),
    "https://idp.example.com/metadata",
    "post",
    "https://sp.example.com/acs",
    "post",
);
let pending = Pending::<AuthnRequest>::from_snapshot(snapshot)?;

assert_eq!(pending.idp_entity_id().as_str(), "https://idp.example.com/metadata");

pub fn snapshot(&self) -> PendingSnapshot<AuthnRequest>

Build a persistable snapshot.

pub fn request_id(&self) -> &MessageId

Request ID.

pub fn request_binding(&self) -> Option<SsoRequestBinding>

Request binding, when tracked.

pub fn response_binding(&self) -> SsoResponseBinding

Expected response binding.

pub fn acs(&self) -> &AcsEndpoint

Selected ACS endpoint.

pub fn idp_entity_id(&self) -> &EntityId

Selected IdP entity ID.

impl Pending<LogoutRequest>

pub fn try_new( request_id: MessageId, relay_state: RelayStateParam, binding: LogoutBinding, peer_entity_id: EntityId, ) -> Result<Pending<LogoutRequest>, SamlError>

Create pending LogoutRequest state without storing keys or metadata.

Errors

Returns SamlError::Invalid when RelayState or peer entity ID are malformed.

pub fn from_snapshot( snapshot: PendingSnapshot<LogoutRequest>, ) -> Result<Pending<LogoutRequest>, SamlError>

Reconstruct pending LogoutRequest state from a snapshot.

AuthnRequest-only ACS snapshot fields are ignored.

Errors

Returns SamlError when any snapshot field is malformed or inconsistent.

Examples

use saml_rs::{LogoutBinding, LogoutRequest, Pending, PendingSnapshot, RelayStateParam};

let snapshot = PendingSnapshot::<LogoutRequest>::logout_request(
    "_logout123",
    RelayStateParam::absent(),
    "https://idp.example.com/metadata",
    LogoutBinding::Post,
);
let pending = Pending::<LogoutRequest>::from_snapshot(snapshot)?;

assert_eq!(pending.peer_entity_id().as_str(), "https://idp.example.com/metadata");

pub fn snapshot(&self) -> PendingSnapshot<LogoutRequest>

Build a persistable snapshot.

pub fn request_binding(&self) -> LogoutBinding

Logout request binding selected for dispatch.

pub fn response_binding(&self) -> LogoutBinding

Expected logout response binding.

Trait Implementations

impl<Message> Clone for Pending<Message>

where Message: Clone + PendingMessage, <Message as PendingMessage>::Details: Clone,

fn clone(&self) -> Pending<Message>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Message> Debug for Pending<Message>

where Message: Debug + PendingMessage, <Message as PendingMessage>::Details: Debug,

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

Formats the value using the given formatter.

impl<Message> Eq for Pending<Message>

where Message: Eq + PendingMessage, <Message as PendingMessage>::Details: Eq,

impl<Message> PartialEq for Pending<Message>

where Message: PartialEq + PendingMessage, <Message as PendingMessage>::Details: PartialEq,

fn eq(&self, other: &Pending<Message>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<Message> StructuralPartialEq for Pending<Message>

where Message: PartialEq + PendingMessage, <Message as PendingMessage>::Details: PartialEq,