Struct IpApiClient

pub struct IpApiClient {
    pub client: Client,
    pub limiter: Option<DefaultDirectRateLimiter>,
    pub api_key: Option<String>,
}

The main client for the ip-api.com API.

Fields

client: Client

The client to use for the requests.

limiter: Option<DefaultDirectRateLimiter>

The rate limiter to use for the requests.

api_key: Option<String>

The API key to use for the requests.

Implementations

impl IpApiClient

pub fn new() -> Self

Creates a new BlockingIpApiClient with no API key.

pub fn new_with_api_key(api_key: String) -> Self

Creates a new IpApiClient with an API key.

Trait Implementations

impl AsyncIpApi for IpApiClient

async fn query_api_default( &self, ip: &str, ) -> Result<IpDefaultResponse, IpApiError>

Queries the API with the default fields.

async fn query_api_fully(&self, ip: &str) -> Result<IpFullResponse, IpApiError>

Queries the API with all fields.

async fn query_api<T>(&self, ip: &str) -> Result<T, IpApiError>

where T: DeserializeOwned,

Queries the API with a custom struct.

fn get_http_client(&self) -> &Client

Gets you the async http client.

impl Default for IpApiClient

fn default() -> Self

Returns the “default value” for a type.

impl IpApi for IpApiClient

fn get_api_key(&self) -> &Option<String>

Gets the optional API key.

fn get_rate_limiter(&self) -> &Option<DefaultDirectRateLimiter>

Gets the rate limiter.