Struct hcaptcha::Hcaptcha

pub struct Hcaptcha { /* fields omitted */ }

Builder to compose a request for the hcaptcha validation endpoint, verify the request and read the additional information that may be supplied in the response.

Implementations

impl Hcaptcha

pub fn new(secret: &str, response: &str) -> Hcaptcha

Create a new Hcaptcha Request

Example

let secret = ""; // your secret key
let token = "";  // user's token

let hcaptcha = Hcaptcha::new(secret, token)
                .verify()
                .await;

assert!(hcaptcha.is_err());

pub fn set_user_ip(self, user_ip: &IpAddr) -> Hcaptcha

Specify the optional ip address value

Example

let secret = ""; // your secret key
let token = "";  // user's token
let user_ip = IpAddr::V4(Ipv4Addr::new(192, 168, 0, 17));

let hcaptcha = Hcaptcha::new(secret, token)
                .set_user_ip(&user_ip)
                .verify()
                .await;

assert!(hcaptcha.is_err());

pub fn set_site_key(self, site_key: &str) -> Hcaptcha

Specify the optional site key value

Example

let secret = ""; // your secret key
let token = "";  // user's token
let site_key = "10000000-ffff-ffff-ffff-000000000001";

let hcaptcha = Hcaptcha::new(secret, token)
                .set_site_key(site_key)
                .verify()
                .await;

assert!(hcaptcha.is_err());

pub async fn verify(&mut self) -> Result<(), HcaptchaError>

Verify a hcaptcha user response

Example

let secret = "0x0000000000000000000000000000000000000000";
let token = "";
let user_ip = IpAddr::V4(Ipv4Addr::new(123, 123, 123, 123));
let site_key = "10000000-ffff-ffff-ffff-000000000001";

let response = Hcaptcha::new(secret, token)
                .set_user_ip(&user_ip)
                .set_site_key(&site_key)
                .verify()
                .await;

assert!(response.is_err());

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

Get the hostname returned in the response Option string containig the hostname of the site where the captcha was solved

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

Get the timestamp from the response Option string containing the timestamp of the captcha (ISO format yyyy-MM-dd’T’HH:mm:ssZZ)

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

Get the credit flag Optional flag showing whether the response will be credited

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

Get the score

ENTERPRISE feature: a score denoting malicious activity.

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

Get the reasons for the score

ENTERPRISE feature: reason(s) for score. See BotStop.com for details.

Trait Implementations

impl Debug for Hcaptcha

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

Formats the value using the given formatter.

impl Default for Hcaptcha

fn default() -> Hcaptcha

Returns the “default value” for a type.