Struct VerificationResult 

pub struct VerificationResult {
    pub valid: bool,
    pub provider: ProviderId,
    pub score: Option<f64>,
    pub action: Option<String>,
    pub hostname: Option<String>,
    pub challenge_time: Option<OffsetDateTime>,
    pub reasons: Vec<FailureReason>,
    pub metadata: BTreeMap<String, Value>,
}

Provider-independent outcome of a CAPTCHA verification attempt.

Fields

valid: bool

Whether the provider accepted the token.

provider: ProviderId

Provider that evaluated the token.

score: Option<f64>

Risk score, commonly from 0.0 to 1.0, when provided.

action: Option<String>

Action returned by the provider, when provided.

hostname: Option<String>

Hostname returned by the provider, when provided.

challenge_time: Option<OffsetDateTime>

Time at which the CAPTCHA challenge was issued, when provided.

reasons: Vec<FailureReason>

Normalized reasons explaining an invalid result.

metadata: BTreeMap<String, Value>

Provider-specific fields not represented by the stable schema.

Implementations

impl VerificationResult

pub fn valid(provider: ProviderId) -> VerificationResult

Creates a valid result with optional fields left empty.

pub fn invalid( provider: ProviderId, reasons: Vec<FailureReason>, ) -> VerificationResult

Creates an invalid result with the supplied normalized reasons.

Trait Implementations

impl Clone for VerificationResult

fn clone(&self) -> VerificationResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VerificationResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VerificationResult

fn deserialize<__D>( __deserializer: __D, ) -> Result<VerificationResult, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VerificationResult

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for VerificationResult

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VerificationResult