Skip to content

Update README example #349

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README example #349

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
403d2f6
update README example to make it easier to plug and play
shubhamkumar13 Aug 8, 2022
72dfa4d
replace [http_types::Error] with [surf::Error] and remove dependency …
shubhamkumar13 Aug 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,21 @@ Whether it's a quick script, or a cross-platform SDK, Surf will make it work.

## Examples
```rust
let mut res = surf::get("https://httpbin.org/get").await?;
dbg!(res.body_string().await?);
#[async_std::main]
async fn main() -> Result<(), surf::Error> {
let mut res = surf::get("https://httpbin.org/get").await?;
dbg!(res.body_string().await?);
Ok(())
}
```

It's also possible to skip the intermediate `Response`, and access the response type directly.
```rust
dbg!(surf::get("https://httpbin.org/get").recv_string().await?);
#[async_std::main]
async fn main() -> Result<(), surf::Error> {
dbg!(surf::get("https://httpbin.org/get").recv_string().await?);
Ok(())
}
```

Both sending and receiving JSON is real easy too.
Expand Down