Struct vt3::VtClient

pub struct VtClient<'a> { /* fields omitted */ }

Implementations

impl<'a> VtClient<'a>

pub fn file_info(self, id: &str) -> Result<Root, VtError>

Retrieve file scan reports id: SHA-256, SHA-1 or MD5 identifying the file

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
vt.file_info("44d88612fea8a8f36de82e1278abb02f");

pub fn file_scan(self, file: &'static str) -> Result<ScanRoot, VtError>

Upload and scan a file

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
println!("{:?}", vt.file_scan("data/eicar.com.txt"));

pub fn file_rescan(self, id: &str) -> Result<ScanRoot, VtError>

Re-submit/Re-scan already submitted files id: SHA-256, SHA-1 or MD5 identifying the file

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
vt.file_rescan("44d88612fea8a8f36de82e1278abb02f");

impl<'a> VtClient<'a>

pub fn ip_info(self, ip_address: &str) -> Result<Root, VtError>

Get the report of a given IP Address

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
println!("{:?}", vt.ip_info("192.168.2.1"));

impl<'a> VtClient<'a>

pub fn url_scan(self, resource_url: &str) -> Result<ScanRoot, VtError>

Scan an URL

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
let url = "https://example.com";
println!("{:?}", vt.url_scan(url));

pub fn url_rescan(self, resource_id: &str) -> Result<ScanRoot, VtError>

Re-analyse/Re-Scan an URL

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
let url = "https://example.com";
println!("{:?}", vt.url_scan(url));

pub fn url_info(self, resource_url: &str) -> Result<Root, VtError>

Get the report of a given Url

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
let resource = "https://www.example.com";
println!("{:?}", vt.url_info(resource));

pub fn url_info_by_id(self, resource_id: &str) -> Result<Root, VtError>

Get the report of a given Url by its resource id. Generally you can first submit a url for scanning, and then, get the resource_id (data.id) and then url_info_by_id(data.id)

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
let resource = "https://www.example.com";
let resource_id = vt.url_scan(resource).unwrap();
println!("{:?}", vt.url_info_by_id(&resource_id.data.id))

impl<'a> VtClient<'a>

pub fn domain_info(self, domain: &'a str) -> Result<Root, VtError>

Get the report of a given Domain

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
println!("{:?}", vt.domain_info("google.com"))

impl<'a> VtClient<'a>

pub fn get_jobs(
    self,
    limit: Option<&str>,
    filter: Option<&str>,
    cursor: Option<&str>
) -> Result<SearchJobRoot, VtError>

Get all or limited RetroHunt jobs

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
vt.get_jobs(Some("10"), None, None);

pub fn get_job_by_id(self, job_id: i32) -> Result<SearchJobRoot, VtError>

Get RetroHunt job by ID

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
vt.get_job_by_id(1);

pub fn create_job(self, data: &SubmitJobRoot) -> Result<SubmitJobRoot, VtError>

Create/Submit a RetroHunt job

Example Usage

use vt3::{VtClient, SubmitJobRoot};

let vt = VtClient::new("Your API Key");
let mut data = SubmitJobRoot::default();
vt.create_job(&data);

pub fn delete_job(self, job_id: i32) -> Result<String, VtError>

Delete RetroHunt job

Example

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
vt.delete_job(1);

pub fn abort_job(self, job_id: i32) -> Result<String, VtError>

Abort a RetroHunt job

Example Usage

use vt3::VtClient;

let vt = VtClient::new("Your API Key");
vt.abort_job(1);

impl<'a> VtClient<'a>

pub fn new(api_key: &'a str) -> Self

Creates a new VirusTotal API Client to access the VirusTotal REST API v3

Example usage

use vt3::VtClient;

let vt_client = VtClient::new("YOUR API KEY");

Trait Implementations

impl<'a> Clone for VtClient<'a>

fn clone(&self) -> VtClient<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for VtClient<'a>