Struct AdmissionRequired 

#[non_exhaustive]
pub struct AdmissionRequired {
    pub challenges: Vec<AdmissionChallengeEntry>,
    pub description: String,
    pub www_authenticate: Vec<String>,
    pub payment_required: Vec<String>,
    pub reason: Option<&'static str>,
}

A remote admission challenge and the bounded response headers needed by a helper.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

challenges: Vec<AdmissionChallengeEntry>

Challenges in server preference order.

description: String

Untrusted server description, retained for the helper.

www_authenticate: Vec<String>

Bounded WWW-Authenticate header values.

payment_required: Vec<String>

Bounded PAYMENT-REQUIRED header values.

reason: Option<&'static str>

Terminal admission state, if a helper already ran or hit its cap.

Implementations

impl AdmissionRequired

pub fn new( challenges: Vec<AdmissionChallengeEntry>, description: String, www_authenticate: Vec<String>, payment_required: Vec<String>, ) -> Self

Construct a remote challenge from already-bounded fields. The Connect client validates the bounds before calling this.

pub fn with_reason(self, reason: &'static str) -> Self

Add a safe terminal explanation without exposing challenge values.

Trait Implementations

impl Clone for AdmissionRequired

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdmissionRequired

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

Formats the value using the given formatter.

impl Display for AdmissionRequired

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

Formats the value using the given formatter.

impl Eq for AdmissionRequired

impl PartialEq for AdmissionRequired

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AdmissionRequired