mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-28 00:00:11 +02:00
Eliza Weisman
647299866a
## Motivation In Tokio 0.2, `AsyncRead` and `AsyncWrite` had `poll_write_buf` and `poll_read_buf` methods for reading and writing to implementers of `bytes` `Buf` and `BufMut` traits. In 0.3, these were removed, but `poll_read_buf` was added as a free function in `tokio-util`. However, there is currently no `poll_write_buf`. Now that `AsyncWrite` has regained support for vectored writes in #3149, there's a lot of potential benefit in having a `poll_write_buf` that uses vectored writes when supported and non-vectored writes when not supported, so that users don't have to reimplement this. ## Solution This PR adds a `poll_write_buf` function to `tokio_util::io`, analogous to the existing `poll_read_buf` function. This function writes from a `Buf` to an `AsyncWrite`, advancing the `Buf`'s internal cursor. In addition, when the `AsyncWrite` supports vectored writes (i.e. its `is_write_vectored` method returns `true`), it will use vectored IO. I copied the documentation for this functions from the docs from Tokio 0.2's `AsyncWrite::poll_write_buf` , with some minor modifications as appropriate. Finally, I fixed a minor issue in the existing docs for `poll_read_buf` and `read_buf`, and updated `tokio_util::codec` to use `poll_write_buf`. Signed-off-by: Eliza Weisman <[email protected]>
57 lines
1.3 KiB
TOML
57 lines
1.3 KiB
TOML
[package]
|
|
name = "tokio-util"
|
|
# When releasing to crates.io:
|
|
# - Remove path dependencies
|
|
# - Update html_root_url.
|
|
# - Update doc url
|
|
# - Cargo.toml
|
|
# - Update CHANGELOG.md.
|
|
# - Create "v0.2.x" git tag.
|
|
version = "0.5.0"
|
|
edition = "2018"
|
|
authors = ["Tokio Contributors <[email protected]>"]
|
|
license = "MIT"
|
|
repository = "https://github.com/tokio-rs/tokio"
|
|
homepage = "https://tokio.rs"
|
|
documentation = "https://docs.rs/tokio-util/0.5.0/tokio_util"
|
|
description = """
|
|
Additional utilities for working with Tokio.
|
|
"""
|
|
categories = ["asynchronous"]
|
|
|
|
[features]
|
|
# No features on by default
|
|
default = []
|
|
|
|
# Shorthand for enabling everything
|
|
full = ["codec", "compat", "io", "time", "net", "rt"]
|
|
|
|
net = ["tokio/net"]
|
|
compat = ["futures-io",]
|
|
codec = ["tokio/stream"]
|
|
time = ["tokio/time","slab"]
|
|
io = []
|
|
rt = ["tokio/rt"]
|
|
|
|
[dependencies]
|
|
tokio = { version = "0.3.4", path = "../tokio" }
|
|
|
|
bytes = "0.6.0"
|
|
futures-core = "0.3.0"
|
|
futures-sink = "0.3.0"
|
|
futures-io = { version = "0.3.0", optional = true }
|
|
log = "0.4"
|
|
pin-project-lite = "0.2.0"
|
|
slab = { version = "0.4.1", optional = true } # Backs `DelayQueue`
|
|
|
|
[dev-dependencies]
|
|
tokio = { version = "0.3.0", path = "../tokio", features = ["full"] }
|
|
tokio-test = { version = "0.3.0", path = "../tokio-test" }
|
|
|
|
futures = "0.3.0"
|
|
futures-test = "0.3.5"
|
|
|
|
[package.metadata.docs.rs]
|
|
all-features = true
|
|
rustdoc-args = ["--cfg", "docsrs"]
|