summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLucio Franco <luciofranco14@gmail.com>2020-03-04 17:27:18 -0500
committerGitHub <noreply@github.com>2020-03-04 17:27:18 -0500
commit5ede2e4d6b2f732e83e33f9693682dffc6c9f5b0 (patch)
treef6abb34c5911fb5da92d0686409d6a675aacb967
parent9d4d076189822e32574f8123efe21c732103f4d4 (diff)
util: Prepare `0.3.0` release (#2296)
Signed-off-by: Lucio Franco <luciofranco14@gmail.com> Co-authored-by: David Barsky <me@davidbarsky.com> Co-authored-by: Eliza Weisman <eliza@buoyant.io>
-rw-r--r--tokio-util/CHANGELOG.md17
-rw-r--r--tokio-util/Cargo.toml2
-rw-r--r--tokio-util/src/lib.rs8
3 files changed, 19 insertions, 8 deletions
diff --git a/tokio-util/CHANGELOG.md b/tokio-util/CHANGELOG.md
index aaabd106..01b4f8c3 100644
--- a/tokio-util/CHANGELOG.md
+++ b/tokio-util/CHANGELOG.md
@@ -1,13 +1,18 @@
-# 0.3.0 (February 28, 2020)
+# 0.3.0 (March 4, 2020)
-Breaking changes:
+### Changed
-- Change codec::Encoder trait to take a generic Item parameter (#1746), which allows
- codec writers to pass references into `Framed` and `FramedWrite` types.
+- **Breaking Change**: Change `Encoder` trait to take a generic `Item` parameter, which allows
+ codec writers to pass references into `Framed` and `FramedWrite` types. (#1746)
-Other additions:
+### Added
-- Add futures-io/tokio::io compatibility layer (#2117)
+- Add futures-io/tokio::io compatibility layer. (#2117)
+- Add `Framed::with_capacity`. (#2215)
+
+### Fixed
+
+- Use advance over split_to when data is not needed. (#2198)
# 0.2.0 (November 26, 2019)
diff --git a/tokio-util/Cargo.toml b/tokio-util/Cargo.toml
index 9a537ba1..f0740199 100644
--- a/tokio-util/Cargo.toml
+++ b/tokio-util/Cargo.toml
@@ -13,7 +13,7 @@ authors = ["Tokio Contributors <team@tokio.rs>"]
license = "MIT"
repository = "https://github.com/tokio-rs/tokio"
homepage = "https://tokio.rs"
-documentation = "https://docs.rs/tokio-util/0.2.0/tokio_util"
+documentation = "https://docs.rs/tokio-util/0.3.0/tokio_util"
description = """
Additional utilities for working with Tokio.
"""
diff --git a/tokio-util/src/lib.rs b/tokio-util/src/lib.rs
index 4554516e..44ec2b74 100644
--- a/tokio-util/src/lib.rs
+++ b/tokio-util/src/lib.rs
@@ -1,4 +1,4 @@
-#![doc(html_root_url = "https://docs.rs/tokio-util/0.2.0")]
+#![doc(html_root_url = "https://docs.rs/tokio-util/0.3.0")]
#![allow(clippy::needless_doctest_main)]
#![warn(
missing_debug_implementations,
@@ -14,6 +14,12 @@
#![cfg_attr(docsrs, feature(doc_cfg))]
//! Utilities for working with Tokio.
+//!
+//! This crate is not versioned in lockstep with the core
+//! [`tokio`] crate. However, `tokio-util` _will_ respect Rust's
+//! semantic versioning policy, especially with regard to breaking changes.
+//!
+//! [`tokio`]: https://docs.rs/tokio
#[macro_use]
mod cfg;