Skip to content

Commit acc433d

Browse files
00xcroypat
authored andcommitted
docs: fix broken links in io module
Signed-off-by: Carlos López <[email protected]>
1 parent 07ab853 commit acc433d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/io.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
// Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
// SPDX-License-Identifier: Apache-2.0
3-
//! Module containing versions of the standard library's [`Read`] and [`Write`] traits compatible
4-
//! with volatile memory accesses.
3+
//! Module containing versions of the standard library's [`Read`](std::io::Read) and
4+
//! [`Write`](std::io::Write) traits compatible with volatile memory accesses.
55
66
use crate::bitmap::BitmapSlice;
77
use crate::volatile_memory::copy_slice_impl::{copy_from_volatile_slice, copy_to_volatile_slice};
88
use crate::{VolatileMemoryError, VolatileSlice};
99
use std::io::{Cursor, ErrorKind, Stdout};
1010
use std::os::fd::AsRawFd;
1111

12-
/// A version of the standard library's [`Read`] trait that operates on volatile memory instead of
13-
/// slices
12+
/// A version of the standard library's [`Read`](std::io::Read) trait that operates on volatile
13+
/// memory instead of slices
1414
///
1515
/// This trait is needed as rust slices (`&[u8]` and `&mut [u8]`) cannot be used when operating on
1616
/// guest memory [1].
@@ -20,7 +20,7 @@ pub trait ReadVolatile {
2020
/// Tries to read some bytes into the given [`VolatileSlice`] buffer, returning how many bytes
2121
/// were read.
2222
///
23-
/// The behavior of implementations should be identical to [`Read::read`]
23+
/// The behavior of implementations should be identical to [`Read::read`](std::io::Read::read)
2424
fn read_volatile<B: BitmapSlice>(
2525
&mut self,
2626
buf: &mut VolatileSlice<B>,
@@ -29,7 +29,7 @@ pub trait ReadVolatile {
2929
/// Tries to fill the given [`VolatileSlice`] buffer by reading from `self` returning an error
3030
/// if insufficient bytes could be read.
3131
///
32-
/// The default implementation is identical to that of [`Read::read_exact`]
32+
/// The default implementation is identical to that of [`Read::read_exact`](std::io::Read::read_exact)
3333
fn read_exact_volatile<B: BitmapSlice>(
3434
&mut self,
3535
buf: &mut VolatileSlice<B>,
@@ -58,8 +58,8 @@ pub trait ReadVolatile {
5858
}
5959
}
6060

61-
/// A version of the standard library's [`Write`] trait that operates on volatile memory instead of
62-
/// slices
61+
/// A version of the standard library's [`Write`](std::io::Write) trait that operates on volatile
62+
/// memory instead of slices.
6363
///
6464
/// This trait is needed as rust slices (`&[u8]` and `&mut [u8]`) cannot be used when operating on
6565
/// guest memory [1].
@@ -69,7 +69,7 @@ pub trait WriteVolatile {
6969
/// Tries to write some bytes from the given [`VolatileSlice`] buffer, returning how many bytes
7070
/// were written.
7171
///
72-
/// The behavior of implementations should be identical to [`Write::write`]
72+
/// The behavior of implementations should be identical to [`Write::write`](std::io::Write::write)
7373
fn write_volatile<B: BitmapSlice>(
7474
&mut self,
7575
buf: &VolatileSlice<B>,
@@ -78,7 +78,7 @@ pub trait WriteVolatile {
7878
/// Tries write the entire content of the given [`VolatileSlice`] buffer to `self` returning an
7979
/// error if not all bytes could be written.
8080
///
81-
/// The default implementation is identical to that of [`Write::write_all`]
81+
/// The default implementation is identical to that of [`Write::write_all`](std::io::Write::write_all)
8282
fn write_all_volatile<B: BitmapSlice>(
8383
&mut self,
8484
buf: &VolatileSlice<B>,

0 commit comments

Comments
 (0)