Struct dehashed_rs::DehashedApi

pub struct DehashedApi { /* private fields */ }

The instance of the dehashed api

Implementations

impl DehashedApi

pub fn new(email: String, api_key: String) -> Result<Self, DehashedError>

Create a new instance of the SDK.

Parameter:

• email: The mail address that is used for authentication
• api_key: The api key for your account (found on your profile page)

This method fails if the Client could not be constructed

pub async fn search(&self, query: Query) -> Result<SearchResult, DehashedError>

Query the API

Please note, that dehashed has a ratelimit protection active, that bans every account that is doing more than 5 req / s.

This method will take care of pagination and will delay requests if necessary.

pub fn start_scheduler(&self) -> Scheduler

Available on crate feature tokio only.

Start a new scheduler.

The Scheduler manages stay in bounds of the rate limit of the unhashed API. It lets you push queries and receive the results.

Trait Implementations

impl Clone for DehashedApi

fn clone(&self) -> DehashedApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DehashedApi

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

Formats the value using the given formatter.