Struct HttpConnector

pub struct HttpConnector { /* private fields */ }

Available on crate feature connector-http only.

A connector to HTTP services.

Examples

use zino_connector::HttpConnector;
use zino_core::{error::Error, state::State, LazyLock, Map};

static AMAP_GEOCODE_CONNECTOR: LazyLock<HttpConnector> = LazyLock::new(|| {
    let config = State::shared()
        .get_config("amap")
        .expect("the `amap` field should be a table");
    let base_url = "https://restapi.amap.com/v3/geocode/geo";
    connector = HttpConnector::try_new("GET", base_url)
        .expect("fail to construct AMap Geocode connector")
        .query("output", "JSON")
        .query("key", config.get_str("key"))
        .query_param("address", None)
        .query_param("city", None)
        .build_query()
        .expect("fail to build a query template for the connector")
});

async fn get_lng_lat(city: &str, address: &str) -> Result<(f32, f32), Error> {
    let params = json!({
        "city": city,
        "address": address,
    });
    let data: Map = AMAP_GEOCODE_CONNECTOR
        .fetch_json(None, params.as_object())
        .await?;
    if let Some(Ok(postions)) = data
        .pointer("/geocodes/0/location")
        .and_then(|v| v.parse_array())
    {
        Ok((postions[0], postions[1]))
    } else {
        bail!("fail to parse the location");
    }
}

Implementations

impl HttpConnector

pub fn try_new(method: &str, base_url: &str) -> Result<Self, Error>

Constructs a new instance, returning an error if it fails.

pub fn try_from_config(config: &Table) -> Result<Self, Error>

Attempts to construct a new instance from the config.

pub fn query(self, key: &str, value: impl Into<JsonValue>) -> Self

Adds a key/value pair for the request query.

pub fn query_param(self, key: &str, param: Option<&str>) -> Self

Adds a parameter for the request query.

pub fn build_query(self) -> Result<Self, Error>

Builds the request query.

pub fn header(self, key: &str, value: impl Into<JsonValue>) -> Self

Adds a key/value pair for the request headers.

pub fn set_path(&mut self, path: &str)

Sets the request path.

pub fn set_query<T: Serialize>(&mut self, query: &T)

Sets the request query.

pub fn set_body<T: Serialize>(&mut self, body: &T)

Sets the request body.

pub fn set_json_pointer(&mut self, pointer: impl Into<String>)

Sets a JSON Pointer for looking up a value from the response data. It only applies when the response data is a JSON object.

pub async fn fetch( &self, query: Option<&str>, params: Option<&Map>, ) -> Result<Response, Error>

Makes an HTTP request with the given query and params.

pub async fn fetch_json<T: DeserializeOwned>( &self, query: Option<&str>, params: Option<&Map>, ) -> Result<T, Error>

Makes an HTTP request with the given query and params, and deserializes the response body via JSON.

Trait Implementations

impl Clone for HttpConnector

fn clone(&self) -> HttpConnector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Connector for HttpConnector

fn try_new_data_source(config: &Table) -> Result<DataSource, Error>

Constructs a new data source with the configuration, returning an error if it fails.

async fn execute( &self, query: &str, params: Option<&Map>, ) -> Result<Option<u64>, Error>

Executes the query and returns the total number of rows affected.

async fn query( &self, query: &str, params: Option<&Map>, ) -> Result<Vec<Record>, Error>

Executes the query and parses it as Vec<Record>.

async fn query_as<T: DeserializeOwned>( &self, query: &str, params: Option<&Map>, ) -> Result<Vec<T>, Error>

Executes the query and parses it as Vec<T>.

async fn query_one( &self, query: &str, params: Option<&Map>, ) -> Result<Option<Record>, Error>

Executes the query and parses it as a Record.

async fn query_one_as<T: DeserializeOwned>( &self, query: &str, params: Option<&Map>, ) -> Result<Option<T>, Error>

Executes the query and parses it as an instance of type T.

impl Debug for HttpConnector

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

Formats the value using the given formatter.