mirror of https://github.com/http-rs/http-client
commit
c36692266a
|
@ -0,0 +1,75 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of
|
||||
experience,
|
||||
education, socio-economic status, nationality, personal appearance, race,
|
||||
religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at yoshuawuyts@gmail.com, or through
|
||||
IRC. All complaints will be reviewed and investigated and will result in a
|
||||
response that is deemed necessary and appropriate to the circumstances. The
|
||||
project team is obligated to maintain confidentiality with regard to the
|
||||
reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
|
||||
available at
|
||||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
|
@ -0,0 +1,55 @@
|
|||
# Contributing
|
||||
Contributions include code, documentation, answering user questions, running the
|
||||
project's infrastructure, and advocating for all types of users.
|
||||
|
||||
The project welcomes all contributions from anyone willing to work in good faith
|
||||
with other contributors and the community. No contribution is too small and all
|
||||
contributions are valued.
|
||||
|
||||
This guide explains the process for contributing to the project's GitHub
|
||||
Repository.
|
||||
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Bad Actors](#bad-actors)
|
||||
|
||||
## Code of Conduct
|
||||
The project has a [Code of Conduct](./CODE_OF_CONDUCT.md) that *all*
|
||||
contributors are expected to follow. This code describes the *minimum* behavior
|
||||
expectations for all contributors.
|
||||
|
||||
As a contributor, how you choose to act and interact towards your
|
||||
fellow contributors, as well as to the community, will reflect back not only
|
||||
on yourself but on the project as a whole. The Code of Conduct is designed and
|
||||
intended, above all else, to help establish a culture within the project that
|
||||
allows anyone and everyone who wants to contribute to feel safe doing so.
|
||||
|
||||
Should any individual act in any way that is considered in violation of the
|
||||
[Code of Conduct](./CODE_OF_CONDUCT.md), corrective actions will be taken. It is
|
||||
possible, however, for any individual to *act* in such a manner that is not in
|
||||
violation of the strict letter of the Code of Conduct guidelines while still
|
||||
going completely against the spirit of what that Code is intended to accomplish.
|
||||
|
||||
Open, diverse, and inclusive communities live and die on the basis of trust.
|
||||
Contributors can disagree with one another so long as they trust that those
|
||||
disagreements are in good faith and everyone is working towards a common
|
||||
goal.
|
||||
|
||||
## Bad Actors
|
||||
All contributors to tacitly agree to abide by both the letter and
|
||||
spirit of the [Code of Conduct](./CODE_OF_CONDUCT.md). Failure, or
|
||||
unwillingness, to do so will result in contributions being respectfully
|
||||
declined.
|
||||
|
||||
A *bad actor* is someone who repeatedly violates the *spirit* of the Code of
|
||||
Conduct through consistent failure to self-regulate the way in which they
|
||||
interact with other contributors in the project. In doing so, bad actors
|
||||
alienate other contributors, discourage collaboration, and generally reflect
|
||||
poorly on the project as a whole.
|
||||
|
||||
Being a bad actor may be intentional or unintentional. Typically, unintentional
|
||||
bad behavior can be easily corrected by being quick to apologize and correct
|
||||
course *even if you are not entirely convinced you need to*. Giving other
|
||||
contributors the benefit of the doubt and having a sincere willingness to admit
|
||||
that you *might* be wrong is critical for any successful open collaboration.
|
||||
|
||||
Don't be a bad actor.
|
|
@ -0,0 +1,74 @@
|
|||
name: CI
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- staging
|
||||
- trying
|
||||
|
||||
env:
|
||||
RUSTFLAGS: -Dwarnings
|
||||
|
||||
jobs:
|
||||
build_and_test:
|
||||
name: Build and test
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, windows-latest, macOS-latest]
|
||||
rust: [stable]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- name: Install ${{ matrix.rust }}
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: ${{ matrix.rust }}
|
||||
override: true
|
||||
|
||||
- name: check
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: check
|
||||
args: --all --bins --examples
|
||||
|
||||
- name: check unstable
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: check
|
||||
args: --all --benches --bins --examples --tests
|
||||
|
||||
- name: tests
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: test
|
||||
args: --all
|
||||
|
||||
check_fmt_and_docs:
|
||||
name: Checking fmt and docs
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- id: component
|
||||
uses: actions-rs/components-nightly@v1
|
||||
with:
|
||||
component: rustfmt
|
||||
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: ${{ steps.component.outputs.toolchain }}
|
||||
override: true
|
||||
|
||||
- name: setup
|
||||
run: |
|
||||
rustup component add rustfmt
|
||||
rustc --version
|
||||
|
||||
- name: fmt
|
||||
run: cargo fmt --all -- --check
|
||||
|
||||
- name: Docs
|
||||
run: cargo doc
|
|
@ -0,0 +1,7 @@
|
|||
coverage/
|
||||
target/
|
||||
tmp/
|
||||
dist/
|
||||
npm-debug.log*
|
||||
Cargo.lock
|
||||
.DS_Store
|
|
@ -0,0 +1,56 @@
|
|||
[package]
|
||||
name = "http-client"
|
||||
version = "1.0.0"
|
||||
license = "MIT OR Apache-2.0"
|
||||
repository = "https://github.com/http-rs/http-client"
|
||||
documentation = "https://docs.rs/http-client"
|
||||
description = "Types and traits for http clients."
|
||||
keywords = ["http", "service", "client", "futures", "async"]
|
||||
categories = ["asynchronous", "web-programming", "web-programming::http-client", "web-programming::websocket"]
|
||||
authors = ["Yoshua Wuyts <yoshuawuyts@gmail.com>"]
|
||||
readme = "README.md"
|
||||
edition = "2018"
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
features = ["docs"]
|
||||
rustdoc-args = ["--cfg", "feature=\"docs\""]
|
||||
|
||||
[features]
|
||||
docs = ["native_client"]
|
||||
native_client = ["curl_client", "wasm_client"]
|
||||
curl_client = ["isahc"]
|
||||
wasm_client = ["js-sys", "web-sys", "wasm-bindgen", "wasm-bindgen-futures"]
|
||||
|
||||
[dependencies]
|
||||
futures-preview = { version = "0.3.0-alpha.19", features = ["compat"] }
|
||||
http = "0.1.19"
|
||||
|
||||
# isahc-client
|
||||
[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
|
||||
isahc = { version = "0.7", optional = true, default-features = false, features = ["http2"] }
|
||||
|
||||
# wasm-client
|
||||
[target.'cfg(target_arch = "wasm32")'.dependencies]
|
||||
js-sys = { version = "0.3.25", optional = true }
|
||||
wasm-bindgen = { version = "0.2.48", optional = true }
|
||||
wasm-bindgen-futures = { version = "0.3.25", features = ["futures_0_3"], optional = true }
|
||||
|
||||
[target.'cfg(target_arch = "wasm32")'.dependencies.web-sys]
|
||||
version = "0.3.25"
|
||||
optional = true
|
||||
features = [
|
||||
"AbortSignal",
|
||||
"Headers",
|
||||
"ObserverCallback",
|
||||
"ReferrerPolicy",
|
||||
"Request",
|
||||
"RequestCache",
|
||||
"RequestCredentials",
|
||||
"RequestInit",
|
||||
"RequestMode",
|
||||
"RequestRedirect",
|
||||
"Response",
|
||||
"Window",
|
||||
]
|
||||
|
||||
[dev-dependencies]
|
|
@ -0,0 +1,190 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
Copyright 2019 Yoshua Wuyts
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2019 Yoshua Wuyts
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
|
@ -0,0 +1,84 @@
|
|||
<h1 align="center">http-client</h1>
|
||||
<div align="center">
|
||||
<strong>
|
||||
Types and traits for http clients.
|
||||
</strong>
|
||||
</div>
|
||||
|
||||
<br />
|
||||
|
||||
<div align="center">
|
||||
<!-- Crates version -->
|
||||
<a href="https://crates.io/crates/http-client">
|
||||
<img src="https://img.shields.io/crates/v/http-client.svg?style=flat-square"
|
||||
alt="Crates.io version" />
|
||||
</a>
|
||||
<!-- Downloads -->
|
||||
<a href="https://crates.io/crates/http-client">
|
||||
<img src="https://img.shields.io/crates/d/http-client.svg?style=flat-square"
|
||||
alt="Download" />
|
||||
</a>
|
||||
<!-- docs.rs docs -->
|
||||
<a href="https://docs.rs/http-client">
|
||||
<img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
|
||||
alt="docs.rs docs" />
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
<h3>
|
||||
<a href="https://docs.rs/http-client">
|
||||
API Docs
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://github.com/async-rs/async-std/releases">
|
||||
Releases
|
||||
</a>
|
||||
<span> | </span>
|
||||
<a href="https://github.com/http-rs/http-client/blob/master.github/CONTRIBUTING.md">
|
||||
Contributing
|
||||
</a>
|
||||
</h3>
|
||||
</div>
|
||||
|
||||
## Installation
|
||||
|
||||
With [cargo add][cargo-add] installed run:
|
||||
|
||||
```sh
|
||||
$ cargo add http-client
|
||||
```
|
||||
|
||||
[cargo-add]: https://github.com/killercup/cargo-edit
|
||||
|
||||
## Safety
|
||||
|
||||
This crate uses ``#![deny(unsafe_code)]`` to ensure everything is implemented in
|
||||
100% Safe Rust.
|
||||
|
||||
## Contributing
|
||||
|
||||
Want to join us? Check out our ["Contributing" guide][contributing] and take a
|
||||
look at some of these issues:
|
||||
|
||||
- [Issues labeled "good first issue"][good-first-issue]
|
||||
- [Issues labeled "help wanted"][help-wanted]
|
||||
|
||||
[contributing]: https://github.com/http-rs/http-client/blob/master.github/CONTRIBUTING.md
|
||||
[good-first-issue]: https://github.com/http-rs/http-client/labels/good%20first%20issue
|
||||
[help-wanted]: https://github.com/http-rs/http-client/labels/help%20wanted
|
||||
|
||||
## License
|
||||
|
||||
<sup>
|
||||
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
|
||||
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
|
||||
</sup>
|
||||
|
||||
<br/>
|
||||
|
||||
<sub>
|
||||
Unless you explicitly state otherwise, any contribution intentionally submitted
|
||||
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
|
||||
be dual licensed as above, without any additional terms or conditions.
|
||||
</sub>
|
|
@ -0,0 +1,56 @@
|
|||
//! http-client implementation for isahc
|
||||
|
||||
use super::{Body, HttpClient, Request, Response};
|
||||
|
||||
use futures::future::BoxFuture;
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
/// Curl-based HTTP Client.
|
||||
#[derive(Debug)]
|
||||
pub struct IsahcClient {
|
||||
client: Arc<isahc::HttpClient>,
|
||||
}
|
||||
|
||||
impl Default for IsahcClient {
|
||||
fn default() -> Self {
|
||||
Self::new()
|
||||
}
|
||||
}
|
||||
|
||||
impl IsahcClient {
|
||||
/// Create a new instance.
|
||||
pub fn new() -> Self {
|
||||
Self {
|
||||
client: Arc::new(isahc::HttpClient::new().unwrap()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Clone for IsahcClient {
|
||||
fn clone(&self) -> Self {
|
||||
Self {
|
||||
client: self.client.clone(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl HttpClient for IsahcClient {
|
||||
type Error = isahc::Error;
|
||||
|
||||
fn send(&self, req: Request) -> BoxFuture<'static, Result<Response, Self::Error>> {
|
||||
let client = self.client.clone();
|
||||
Box::pin(async move {
|
||||
let (parts, body) = req.into_parts();
|
||||
let body = isahc::Body::reader(body);
|
||||
let req: http::Request<isahc::Body> = http::Request::from_parts(parts, body);
|
||||
|
||||
let res = client.send_async(req).await?;
|
||||
|
||||
let (parts, body) = res.into_parts();
|
||||
let body = Body::from_reader(body);
|
||||
let res = http::Response::from_parts(parts, body);
|
||||
Ok(res)
|
||||
})
|
||||
}
|
||||
}
|
|
@ -0,0 +1,120 @@
|
|||
//! Types and traits for http clients.
|
||||
//!
|
||||
//! This crate has been extracted from `surf`'s internals, but can be used by any http client impl.
|
||||
//! The purpose of this crate is to provide a unified interface for multiple HTTP client backends,
|
||||
//! so that they can be abstracted over without doing extra work.
|
||||
|
||||
#![forbid(unsafe_code, future_incompatible, rust_2018_idioms)]
|
||||
#![deny(missing_debug_implementations, nonstandard_style)]
|
||||
#![warn(missing_docs, missing_doc_code_examples, unreachable_pub)]
|
||||
#![cfg_attr(feature = "docs", feature(doc_cfg))]
|
||||
|
||||
use futures::future::BoxFuture;
|
||||
use futures::io::AsyncRead;
|
||||
|
||||
use std::error::Error;
|
||||
use std::fmt::{self, Debug};
|
||||
use std::io;
|
||||
use std::pin::Pin;
|
||||
use std::task::{Context, Poll};
|
||||
|
||||
#[cfg_attr(feature = "docs", doc(cfg(curl_client)))]
|
||||
#[cfg(all(feature = "curl_client", not(target_arch = "wasm32")))]
|
||||
pub mod isahc;
|
||||
|
||||
#[cfg_attr(feature = "docs", doc(cfg(wasm_client)))]
|
||||
#[cfg(all(feature = "wasm_client", target_arch = "wasm32"))]
|
||||
pub mod wasm;
|
||||
|
||||
#[cfg_attr(feature = "docs", doc(cfg(native_client)))]
|
||||
#[cfg(feature = "native_client")]
|
||||
pub mod native;
|
||||
|
||||
/// An HTTP Request type with a streaming body.
|
||||
pub type Request = http::Request<Body>;
|
||||
|
||||
/// An HTTP Response type with a streaming body.
|
||||
pub type Response = http::Response<Body>;
|
||||
|
||||
/// An abstract HTTP client.
|
||||
///
|
||||
/// __note that this is only exposed for use in middleware. Building new backing clients is not
|
||||
/// recommended yet. Once it is we'll likely publish a new `http_client` crate, and re-export this
|
||||
/// trait from there together with all existing HTTP client implementations.__
|
||||
///
|
||||
/// ## Spawning new request from middleware
|
||||
/// When threading the trait through a layer of middleware, the middleware must be able to perform
|
||||
/// new requests. In order to enable this we pass an `HttpClient` instance through the middleware,
|
||||
/// with a `Clone` implementation. In order to spawn a new request, `clone` is called, and a new
|
||||
/// request is enabled.
|
||||
///
|
||||
/// How `Clone` is implemented is up to the implementors, but in an ideal scenario combining this
|
||||
/// with the `Client` builder will allow for high connection reuse, improving latency.
|
||||
pub trait HttpClient: Debug + Unpin + Send + Sync + Clone + 'static {
|
||||
/// The associated error type.
|
||||
type Error: Error + Send + Sync;
|
||||
|
||||
/// Perform a request.
|
||||
fn send(&self, req: Request) -> BoxFuture<'static, Result<Response, Self::Error>>;
|
||||
}
|
||||
|
||||
/// The raw body of an http request or response.
|
||||
///
|
||||
/// A body is a stream of `Bytes` values, which are shared handles to byte buffers.
|
||||
/// Both `Body` and `Bytes` values can be easily created from standard owned byte buffer types
|
||||
/// like `Vec<u8>` or `String`, using the `From` trait.
|
||||
pub struct Body {
|
||||
reader: Box<dyn AsyncRead + Unpin + Send + 'static>,
|
||||
}
|
||||
|
||||
impl Body {
|
||||
/// Create a new empty body.
|
||||
pub fn empty() -> Self {
|
||||
Self {
|
||||
reader: Box::new(futures::io::empty()),
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a new instance from a reader.
|
||||
pub fn from_reader(reader: impl AsyncRead + Unpin + Send + 'static) -> Self {
|
||||
Self {
|
||||
reader: Box::new(reader),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl AsyncRead for Body {
|
||||
#[allow(missing_doc_code_examples)]
|
||||
fn poll_read(
|
||||
mut self: Pin<&mut Self>,
|
||||
cx: &mut Context<'_>,
|
||||
buf: &mut [u8],
|
||||
) -> Poll<io::Result<usize>> {
|
||||
Pin::new(&mut self.reader).poll_read(cx, buf)
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Debug for Body {
|
||||
#[allow(missing_doc_code_examples)]
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
f.debug_struct("Body").field("reader", &"<hidden>").finish()
|
||||
}
|
||||
}
|
||||
|
||||
impl From<Vec<u8>> for Body {
|
||||
#[allow(missing_doc_code_examples)]
|
||||
#[inline]
|
||||
fn from(vec: Vec<u8>) -> Body {
|
||||
Self {
|
||||
reader: Box::new(io::Cursor::new(vec)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<R: AsyncRead + Unpin + Send + 'static> From<Box<R>> for Body {
|
||||
/// Converts an `AsyncRead` into a Body.
|
||||
#[allow(missing_doc_code_examples)]
|
||||
fn from(reader: Box<R>) -> Self {
|
||||
Self { reader }
|
||||
}
|
||||
}
|
|
@ -0,0 +1,7 @@
|
|||
//! http-client implementation for curl + fetch
|
||||
|
||||
#[cfg(all(feature = "curl_client", not(target_arch = "wasm32")))]
|
||||
pub use super::isahc::IsahcClient as NativeClient;
|
||||
|
||||
#[cfg(all(feature = "wasm-client", target_arch = "wasm32"))]
|
||||
pub use super::wasm::WasmClient as NativeClient;
|
|
@ -0,0 +1,206 @@
|
|||
//! http-client implementation for fetch
|
||||
|
||||
use super::{Body, HttpClient, Request, Response};
|
||||
|
||||
use futures::future::BoxFuture;
|
||||
use futures::prelude::*;
|
||||
|
||||
use std::io;
|
||||
use std::pin::Pin;
|
||||
use std::task::{Context, Poll};
|
||||
|
||||
/// WebAssembly HTTP Client.
|
||||
#[derive(Debug)]
|
||||
pub struct WasmClient {
|
||||
_priv: (),
|
||||
}
|
||||
|
||||
impl WasmClient {
|
||||
/// Create a new instance.
|
||||
pub fn new() -> Self {
|
||||
Self { _priv: () }
|
||||
}
|
||||
}
|
||||
|
||||
impl Clone for WasmClient {
|
||||
fn clone(&self) -> Self {
|
||||
Self { _priv: () }
|
||||
}
|
||||
}
|
||||
|
||||
impl HttpClient for WasmClient {
|
||||
type Error = std::io::Error;
|
||||
|
||||
fn send(&self, req: Request) -> BoxFuture<'static, Result<Response, Self::Error>> {
|
||||
let fut = Box::pin(async move {
|
||||
let url = format!("{}", req.uri());
|
||||
let req = fetch::new(req.method().as_str(), &url);
|
||||
let mut res = req.send().await?;
|
||||
|
||||
let body = res.body_bytes();
|
||||
let mut response = Response::new(Body::from(body));
|
||||
*response.status_mut() = http::StatusCode::from_u16(res.status()).unwrap();
|
||||
|
||||
for (name, value) in res.headers() {
|
||||
let name: http::header::HeaderName = name.parse().unwrap();
|
||||
response.headers_mut().insert(name, value.parse().unwrap());
|
||||
}
|
||||
|
||||
Ok(response)
|
||||
});
|
||||
|
||||
Box::pin(InnerFuture { fut })
|
||||
}
|
||||
}
|
||||
|
||||
// This type e
|
||||
struct InnerFuture {
|
||||
fut: Pin<Box<dyn Future<Output = Result<Response, io::Error>> + 'static>>,
|
||||
}
|
||||
|
||||
// This is safe because WASM doesn't have threads yet. Once WASM supports threads we should use a
|
||||
// thread to park the blocking implementation until it's been completed.
|
||||
unsafe impl Send for InnerFuture {}
|
||||
|
||||
impl Future for InnerFuture {
|
||||
type Output = Result<Response, io::Error>;
|
||||
|
||||
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||
// This is safe because we're only using this future as a pass-through for the inner
|
||||
// future, in order to implement `Send`. If it's safe to poll the inner future, it's safe
|
||||
// to proxy it too.
|
||||
unsafe { Pin::new_unchecked(&mut self.fut).poll(cx) }
|
||||
}
|
||||
}
|
||||
|
||||
mod fetch {
|
||||
use js_sys::{Array, ArrayBuffer, Reflect, Uint8Array};
|
||||
use wasm_bindgen::JsCast;
|
||||
use wasm_bindgen_futures::futures_0_3::JsFuture;
|
||||
use web_sys::window;
|
||||
use web_sys::RequestInit;
|
||||
|
||||
use std::io;
|
||||
use std::iter::{IntoIterator, Iterator};
|
||||
|
||||
/// Create a new fetch request.
|
||||
pub(crate) fn new(method: impl AsRef<str>, url: impl AsRef<str>) -> Request {
|
||||
Request::new(method, url)
|
||||
}
|
||||
|
||||
/// An HTTP Fetch Request.
|
||||
pub(crate) struct Request {
|
||||
init: RequestInit,
|
||||
url: String,
|
||||
}
|
||||
|
||||
impl Request {
|
||||
/// Create a new instance.
|
||||
pub(crate) fn new(method: impl AsRef<str>, url: impl AsRef<str>) -> Self {
|
||||
let mut init = web_sys::RequestInit::new();
|
||||
init.method(method.as_ref());
|
||||
Self {
|
||||
init,
|
||||
url: url.as_ref().to_owned(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Submit a request
|
||||
// TODO(yoshuawuyts): turn this into a `Future` impl on `Request` instead.
|
||||
pub(crate) async fn send(self) -> Result<Response, io::Error> {
|
||||
// Send the request.
|
||||
let window = window().expect("A global window object could not be found");
|
||||
let request = web_sys::Request::new_with_str_and_init(&self.url, &self.init).unwrap();
|
||||
let promise = window.fetch_with_request(&request);
|
||||
let resp = JsFuture::from(promise).await.unwrap();
|
||||
debug_assert!(resp.is_instance_of::<web_sys::Response>());
|
||||
let res: web_sys::Response = resp.dyn_into().unwrap();
|
||||
|
||||
// Get the request body.
|
||||
let promise = res.array_buffer().unwrap();
|
||||
let resp = JsFuture::from(promise).await.unwrap();
|
||||
debug_assert!(resp.is_instance_of::<js_sys::ArrayBuffer>());
|
||||
let buf: ArrayBuffer = resp.dyn_into().unwrap();
|
||||
let slice = Uint8Array::new(&buf);
|
||||
let mut body: Vec<u8> = vec![0; slice.length() as usize];
|
||||
slice.copy_to(&mut body);
|
||||
|
||||
Ok(Response::new(res, body))
|
||||
}
|
||||
}
|
||||
|
||||
/// An HTTP Fetch Response.
|
||||
pub(crate) struct Response {
|
||||
res: web_sys::Response,
|
||||
body: Option<Vec<u8>>,
|
||||
}
|
||||
|
||||
impl Response {
|
||||
fn new(res: web_sys::Response, body: Vec<u8>) -> Self {
|
||||
Self {
|
||||
res,
|
||||
body: Some(body),
|
||||
}
|
||||
}
|
||||
|
||||
/// Access the HTTP headers.
|
||||
pub(crate) fn headers(&self) -> Headers {
|
||||
Headers {
|
||||
headers: self.res.headers(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Get the request body as a byte vector.
|
||||
///
|
||||
/// Returns an empty vector if the body has already been consumed.
|
||||
pub(crate) fn body_bytes(&mut self) -> Vec<u8> {
|
||||
self.body.take().unwrap_or_else(|| vec![])
|
||||
}
|
||||
|
||||
/// Get the HTTP return status code.
|
||||
pub(crate) fn status(&self) -> u16 {
|
||||
self.res.status()
|
||||
}
|
||||
}
|
||||
|
||||
/// HTTP Headers.
|
||||
pub(crate) struct Headers {
|
||||
headers: web_sys::Headers,
|
||||
}
|
||||
|
||||
impl IntoIterator for Headers {
|
||||
type Item = (String, String);
|
||||
type IntoIter = HeadersIter;
|
||||
|
||||
fn into_iter(self) -> Self::IntoIter {
|
||||
HeadersIter {
|
||||
iter: js_sys::try_iter(&self.headers).unwrap().unwrap(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// HTTP Headers Iterator.
|
||||
pub(crate) struct HeadersIter {
|
||||
iter: js_sys::IntoIter,
|
||||
}
|
||||
|
||||
impl Iterator for HeadersIter {
|
||||
type Item = (String, String);
|
||||
|
||||
fn next(&mut self) -> Option<Self::Item> {
|
||||
let pair = self.iter.next()?;
|
||||
|
||||
let array: Array = pair.unwrap().into();
|
||||
let vals = array.values();
|
||||
|
||||
let prop = String::from("value").into();
|
||||
let key = Reflect::get(&vals.next().unwrap(), &prop).unwrap();
|
||||
let value = Reflect::get(&vals.next().unwrap(), &prop).unwrap();
|
||||
|
||||
Some((
|
||||
key.as_string().to_owned().unwrap(),
|
||||
value.as_string().to_owned().unwrap(),
|
||||
))
|
||||
}
|
||||
}
|
||||
}
|
|
@ -0,0 +1,6 @@
|
|||
use std::error::Error;
|
||||
|
||||
#[test]
|
||||
fn should_work() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
|
||||
Ok(())
|
||||
}
|
Loading…
Reference in New Issue