lib/ureq
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Correctness doc comment

Browse Source
This commit is contained in:
Martin Algesten
2019-10-20 19:32:18 +02:00
parent 3642e27a26
commit 9afbb834af
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -47,12 +47,28 @@ You can control them when including `ureq` as a dependency.
* Minimal dependency tree * Minimal dependency tree
* Obvious API * Obvious API
* Convencience over correctness
This library tries to provide a convenient request library with a minimal dependency This library tries to provide a convenient request library with a minimal dependency
tree and an obvious API. It is inspired by libraries like tree and an obvious API. It is inspired by libraries like
[superagent](http://visionmedia.github.io/superagent/) and [superagent](http://visionmedia.github.io/superagent/) and
[fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
This library does not try to enforce web standards correctness. It uses HTTP/1.1,
but whether the request is _perfect_ HTTP/1.1 compatible is up to the user of the
library. For example:
```rust
let resp = ureq::post("https://myapi.acme.com/blah")
.set("Jättegött", "Vegankörv")
.call();
```
The header name and value would be encoded in utf-8 and sent, but that is actually not
correct according to spec cause an HTTP header name should be ascii. The absolutely
correct way would be to have `.set(header, value)` return a `Result`. This library opts
for convenience over correctness, so the decision is left to the user.
### Sync (for now) ### Sync (for now)
This library uses blocking socket reads and writes, for now. This library uses blocking socket reads and writes, for now.