Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example dependency using the blocking feature in README.md is wrong. #60

Closed
nahaharo opened this issue Jan 22, 2021 · 1 comment
Closed

Comments

@nahaharo
Copy link

README.md says that you need to select features as "blocking" to use synchronous feature.
But I think correct option for use synchronous is "reqwest_blocking".

Please change "features = ["blocking"]" to "features = ["reqwest_blocking"]".

Problem section

[dependencies]
## This one is async
arangors = { version = "0.4", default-features = false }
## This one is synchronous
arangors = { version = "0.4", features = ["blocking"], default-features = false }```
@fMeow
Copy link
Owner

fMeow commented Jan 27, 2021

Thank you for your feedback!!

Actually, this is not a mistake. The statement above this examples goes in the following way:

Or if you want to stick with other ecosystem that are not listed in the feature gate,
you can get vanilla arangors without any HTTP client dependency:

This is intended for someone that wants a vanilla arangors and works on their own HTTP implementation. In other words, a clean arangors without any HTTP implmentation. This is useful when someone is dedicated to a ecosystem of HTTP client that is nerither reqwest nor async std.

Currently, out-of-box implementation are of the following:

  • reqwest_async
  • reqwest_blocking
  • surf_async

And among the three features, reqwest_blocking is the only blocking implementation.

Thank you! :)

@fMeow fMeow closed this as completed Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants