diff options
author | 2022-03-25 05:55:13 -0400 | |
---|---|---|
committer | 2022-03-25 10:55:13 +0100 | |
commit | e4c723697d49b5b6fa1ae92db18e9affe6c6744f (patch) | |
tree | efffd0d4f9f96a68cc572a3efd3647a2162e8a23 | |
parent | d4f5023383d233819e727d2b223493ba1c730211 (diff) | |
download | bytes-e4c723697d49b5b6fa1ae92db18e9affe6c6744f.tar.gz bytes-e4c723697d49b5b6fa1ae92db18e9affe6c6744f.tar.zst bytes-e4c723697d49b5b6fa1ae92db18e9affe6c6744f.zip |
docs: redraw layout diagram with box drawing characters. (#539)
I find this diagram very helpful, but a little hard to distinguish
between the boxes and the lines that connect them. This commit redraws
the boxes with line drawing characters so that the boxes appear a
little more solid, and stand out from the other lines.
-rw-r--r-- | src/bytes.rs | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/bytes.rs b/src/bytes.rs index f3e4c5c..753bb5c 100644 --- a/src/bytes.rs +++ b/src/bytes.rs @@ -55,7 +55,7 @@ use crate::Buf; /// # Sharing /// /// `Bytes` contains a vtable, which allows implementations of `Bytes` to define -/// how sharing/cloneing is implemented in detail. +/// how sharing/cloning is implemented in detail. /// When `Bytes::clone()` is called, `Bytes` will call the vtable function for /// cloning the backing storage in order to share it behind between multiple /// `Bytes` instances. @@ -78,18 +78,18 @@ use crate::Buf; /// /// ```text /// -/// Arc ptrs +---------+ -/// ________________________ / | Bytes 2 | -/// / +---------+ -/// / +-----------+ | | -/// |_________/ | Bytes 1 | | | -/// | +-----------+ | | +/// Arc ptrs ┌─────────┐ +/// ________________________ / │ Bytes 2 │ +/// / └─────────┘ +/// / ┌───────────┐ | | +/// |_________/ │ Bytes 1 │ | | +/// | └───────────┘ | | /// | | | ___/ data | tail /// | data | tail |/ | /// v v v v -/// +-----+---------------------------------+-----+ -/// | Arc | | | | | -/// +-----+---------------------------------+-----+ +/// ┌─────┬─────┬───────────┬───────────────┬─────┐ +/// │ Arc │ │ │ │ │ +/// └─────┴─────┴───────────┴───────────────┴─────┘ /// ``` pub struct Bytes { ptr: *const u8, |