13 releases
0.5.1 | Jul 18, 2021 |
---|---|
0.5.0 | Jan 9, 2021 |
0.4.3 | Nov 18, 2020 |
0.3.1 | Jul 20, 2020 |
0.1.1 | Dec 26, 2018 |
#538 in Configuration
39 downloads per month
330KB
3.5K
SLoC
Spirit-hyper
A helper to create configured reqwest client and a helper to keep one around with up to date configuration. It is part of the spirit system.
See the docs and the examples.
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
lib.rs
:
This helps with configuring the reqwest
Client
.
This is part of the spirit
system.
There are two levels of support. The first one is just letting the Spirit
to load the
ReqwestClient
configuration fragment and calling one of its methods to create the
Client
or others.
The other, more convenient way, is pairing an extractor function with the
AtomicClient
and
letting Spirit
keep an up to date version of Client
in there at all times.
The split and features
The ReqwestClient
lives at the top of the crate. However, reqwest
provides both
blocking and async flavours of the HTTP client. For that reason, this crate provides two
submodules, each with the relevant support (note that the name of the async one is futures
,
because async
is a keyword). The pipeline is configured with the relevant IntoClient
transformation and installed into the relevant AtomicClient
.
Features enable parts of the functionality here and correspond to some of the features of
reqwest
. In particular:
gzip
: Theenable-gzip
configuration option.brotli
: Theenable-brotli
configuration option.native-tls
: Thetls-identity
,tls-identity-password
andtls-accept-invalid-hostnames
options.blocking
: The wholeblocking
module and methods for creating the blocking client and builder.
Porting from the 0.3 version
- You may need to enable certain features (if you want to keep using the blocking API, you need
the
blocking
feature, but you also may want thenative-tls
andgzip
features to get the same feature coverage). - Part of what you used moved to the submodule, but otherwise should have same or similar API
- The pipeline needs the addition of
.transform(IntoClient)
between config extraction and installation, to choose if you are interested in blocking or async flavour.
Examples
use serde::Deserialize;
use spirit::{Empty, Pipeline, Spirit};
use spirit::prelude::*;
use spirit_reqwest::ReqwestClient;
// Here we choose if we want blocking or async (futures module)
use spirit_reqwest::blocking::{AtomicClient, IntoClient};
#[derive(Debug, Default, Deserialize)]
struct Cfg {
#[serde(default)]
client: ReqwestClient,
}
impl Cfg {
fn client(&self) -> ReqwestClient {
self.client.clone()
}
}
fn main() {
let client = AtomicClient::unconfigured(); // Get a default config before we get configured
Spirit::<Empty, Cfg>::new()
.with(
Pipeline::new("http client")
.extract_cfg(Cfg::client)
// Choose if you want blocking or async client
// (eg. spirit_reqwest::blocking::IntoClient or
// spirit_reqwest::futures::IntoClient)
.transform(IntoClient)
// Choose where to store it
.install(client.clone())
)
.run(move |_| {
let page = client
.get("https://www.rust-lang.org")
.send()?
.error_for_status()?
.text()?;
println!("{}", page);
Ok(())
});
}
Dependencies
~6–19MB
~319K SLoC