Struct hcaptcha::HcaptchaResponse

pub struct HcaptchaResponse { /* private fields */ }

Result from call to verify the client’s response

Implementations

impl HcaptchaResponse

pub fn success(&self) -> bool

Get the value of the success field

Example

    let response = client.verify_client_response(request).await?;
    println!("Success returns true: {}", response.success());

pub fn hostname(&self) -> Option<String>

Get the value of the hostname field

Example

    let response = client.verify_client_response(request).await?;

    if let Some(hostname) = response.hostname() {
        println!("Timestamp: {}", hostname);
    };

pub fn timestamp(&self) -> Option<String>

Get the value of the timestamp field

Example

    let response = client.verify_client_response(request).await?;

    if let Some(timestamp) = response.timestamp() {
        println!("Timestamp: {}", timestamp);
    };

pub fn credit(&self) -> Option<bool>

Get the value of the credit field

Example

    let response = client.verify_client_response(request).await?;

    if let Some(credit) = response.credit() {
        println!("Timestamp: {}", credit);
    };

pub fn error_codes(&self) -> Option<HashSet<Code>>

Get the value of the error_codes field

Example

    let response = client.verify_client_response(request).await?;

    if let Some(error_codes) = response.error_codes() {
        println!("Error Codes: {:?}", error_codes);
    };

pub fn score(&self) -> Option<f32>

Available on crate feature enterprise only.

Get the value of the score field

Example

    let response = client.verify_client_response(request).await?;

    if let Some(score) = response.score() {
        println!("Score: {}", score);
    };

pub fn score_reason(&self) -> Option<HashSet<String>>

Available on crate feature enterprise only.

Get the value of the score_reason field

Example

    let response = client.verify_client_response(request).await?;

    if let Some(score_reason) = response.score_reason() {
        println!("Score reasons: {:?}", score_reason);
    };

Trait Implementations

impl Clone for HcaptchaResponse

fn clone(&self) -> HcaptchaResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HcaptchaResponse

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

Formats the value using the given formatter.

impl Default for HcaptchaResponse

fn default() -> HcaptchaResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HcaptchaResponse

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

Deserialize this value from the given Serde deserializer.

impl Display for HcaptchaResponse

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

Formats the value using the given formatter.