aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorGravatar Gabriel Goller <gabrielgoller123@gmail.com> 2023-11-16 12:24:21 +0100
committerGravatar GitHub <noreply@github.com> 2023-11-16 06:24:21 -0500
commit72cbb92e0e53680c67c27b56fabbe1f3ed5dbae9 (patch)
tree3973e0862571346f83ee1bce657a784b1d50d56f /src/lib.rs
parentbde8c50703869f54b905560eb62c2478a0111885 (diff)
downloadbytes-72cbb92e0e53680c67c27b56fabbe1f3ed5dbae9.tar.gz
bytes-72cbb92e0e53680c67c27b56fabbe1f3ed5dbae9.tar.zst
bytes-72cbb92e0e53680c67c27b56fabbe1f3ed5dbae9.zip
docs: fix broken links (#639)
Fixed a few broken links and converted a lot of them from the html-link to intra-doc links.
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs11
1 files changed, 3 insertions, 8 deletions
diff --git a/src/lib.rs b/src/lib.rs
index d2d970b..1b3e6fc 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -9,12 +9,9 @@
//! Provides abstractions for working with bytes.
//!
//! The `bytes` crate provides an efficient byte buffer structure
-//! ([`Bytes`](struct.Bytes.html)) and traits for working with buffer
+//! ([`Bytes`]) and traits for working with buffer
//! implementations ([`Buf`], [`BufMut`]).
//!
-//! [`Buf`]: trait.Buf.html
-//! [`BufMut`]: trait.BufMut.html
-//!
//! # `Bytes`
//!
//! `Bytes` is an efficient container for storing and operating on contiguous
@@ -52,9 +49,7 @@
//! `a` and `b` will share the underlying buffer and maintain indices tracking
//! the view into the buffer represented by the handle.
//!
-//! See the [struct docs] for more details.
-//!
-//! [struct docs]: struct.Bytes.html
+//! See the [struct docs](`Bytes`) for more details.
//!
//! # `Buf`, `BufMut`
//!
@@ -70,7 +65,7 @@
//! ## Relation with `Read` and `Write`
//!
//! At first glance, it may seem that `Buf` and `BufMut` overlap in
-//! functionality with `std::io::Read` and `std::io::Write`. However, they
+//! functionality with [`std::io::Read`] and [`std::io::Write`]. However, they
//! serve different purposes. A buffer is the value that is provided as an
//! argument to `Read::read` and `Write::write`. `Read` and `Write` may then
//! perform a syscall, which has the potential of failing. Operations on `Buf`