Struct rocheck::RoCheck

pub struct RoCheck { /* fields omitted */ }

Methods

impl RoCheck

pub fn new(cookie: &str) -> RoCheck

Create and initialize a new RoCheck class.

let client = RoCheck::new("MySecurityToken");

pub async fn get_data<'_, '_>(
    &'_ self,
    place_id: i64,
    job_id: &'_ str
) -> Result<HashMap<String, Value>, Box<dyn Error>>

Retrieve additional data other than the IP.

let client = RoCheck::new("MySecurityToken");
let data = client.get_data(123456, "JobIdFromRequest").await?;
data.get("some-field");

pub async fn get_ip<'_, '_>(
    &'_ self,
    place_id: i64,
    job_id: &'_ str
) -> Result<String, Box<dyn Error>>

Retrieve the IP belonging to this PlaceId and JobId

let client = RoCheck::new("MySecurityToken");
let ip = client.get_ip(123456, "JobIdFromRequest").await?;

pub async fn verify_ip<'_, '_, '_>(
    &'_ self,
    place_id: i64,
    job_id: &'_ str,
    ip: &'_ str
) -> Result<bool, Box<dyn Error>>

Retrieve the IP belonging to this PlaceId and JobId and compare it to the inputted IP.

let my_ip = "127.0.0.1";
let client = RoCheck::new("MySecurityToken");
		
let ip_verified = client.verify_ip(123456, "JobIdFromRequest", my_ip).await?;

pub async fn validate_ip<'_, '_, '_>(
    &'_ self,
    place_id: i64,
    job_id: &'_ str,
    ip: &'_ str
) -> bool

This function is equivalent to verify_ip, however it will always return true/false. If this function fails, it will return false. This is useful for cases where you don't need to know why it failed (e.g place_id doesn't exist, or job id doesn't exist) without adding boilerplate.

let my_ip = "127.0.0.1";
let client = RoCheck::new("MySecurityToken");

let ip_verified = client.validate_ip(123456i64, "JobIdFromRequest", my_ip).await;