Skip to content

Commit d9da493

Browse files
fix style in code examples
Signed-off-by: Andreea Florescu <[email protected]>
1 parent 420e424 commit d9da493

File tree

7 files changed

+28
-23
lines changed

7 files changed

+28
-23
lines changed

src/fam.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ pub enum Error {
109109
///
110110
/// type MockFamStructWrapper = FamStructWrapper<MockFamStruct>;
111111
/// ```
112-
///
113112
#[allow(clippy::len_without_is_empty)]
114113
pub unsafe trait FamStruct {
115114
/// The type of the FAM entries

src/linux/aio.rs

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,14 @@ impl IoContext {
116116
/// let file = File::open("/dev/zero").unwrap();
117117
/// let ctx = IoContext::new(128).unwrap();
118118
/// let mut buf: [u8; 4096] = unsafe { std::mem::uninitialized() };
119-
/// let iocbs = [
120-
/// &mut IoControlBlock {
121-
/// aio_fildes: file.as_raw_fd() as u32,
122-
/// aio_lio_opcode: IOCB_CMD_PREAD as u16,
123-
/// aio_buf: buf.as_mut_ptr() as u64,
124-
/// aio_nbytes: buf.len() as u64,
125-
/// ..Default::default()
126-
/// },
127-
/// ];
119+
/// let iocbs = [&mut IoControlBlock {
120+
/// aio_fildes: file.as_raw_fd() as u32,
121+
/// aio_lio_opcode: IOCB_CMD_PREAD as u16,
122+
/// aio_buf: buf.as_mut_ptr() as u64,
123+
/// aio_nbytes: buf.len() as u64,
124+
/// ..Default::default()
125+
/// }];
128126
/// assert_eq!(ctx.submit(&iocbs[..]).unwrap(), 1);
129-
///
130127
/// ```
131128
pub fn submit(&self, iocbs: &[&mut IoControlBlock]) -> Result<usize> {
132129
let rc = unsafe {

src/linux/ioctl.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ type IoctlRequest = c_ulong;
223223
///
224224
/// ```
225225
/// # extern crate libc;
226-
/// #[macro_use] extern crate vmm_sys_util;
226+
/// # #[macro_use] extern crate vmm_sys_util;
227227
/// #
228228
/// # use libc::{open, O_CLOEXEC, O_RDWR};
229229
/// # use std::fs::File;
@@ -265,7 +265,7 @@ pub unsafe fn ioctl<F: AsRawFd>(fd: &F, req: c_ulong) -> c_int {
265265
///
266266
/// ```
267267
/// # extern crate libc;
268-
/// #[macro_use] extern crate vmm_sys_util;
268+
/// # #[macro_use] extern crate vmm_sys_util;
269269
/// # use libc::{open, O_CLOEXEC, O_RDWR};
270270
/// # use std::fs::File;
271271
/// # use std::os::raw::{c_char, c_uint, c_ulong};

src/linux/poll.rs

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,8 @@ impl<T: PollToken> EpollContext<T> {
438438
///
439439
/// let evt = EventFd::new(0).unwrap();
440440
/// let ctx: EpollContext<u32> = EpollContext::new().unwrap();
441-
/// ctx.add_fd_with_events(&evt, WatchingEvents::empty().set_read(), 1).unwrap();
441+
/// ctx.add_fd_with_events(&evt, WatchingEvents::empty().set_read(), 1)
442+
/// .unwrap();
442443
/// ```
443444
pub fn add_fd_with_events(
444445
&self,
@@ -486,8 +487,10 @@ impl<T: PollToken> EpollContext<T> {
486487
///
487488
/// let evt = EventFd::new(0).unwrap();
488489
/// let ctx: EpollContext<u32> = EpollContext::new().unwrap();
489-
/// ctx.add_fd_with_events(&evt, WatchingEvents::empty().set_read(), 1).unwrap();
490-
/// ctx.modify(&evt, WatchingEvents::empty().set_write(), 2).unwrap();
490+
/// ctx.add_fd_with_events(&evt, WatchingEvents::empty().set_read(), 1)
491+
/// .unwrap();
492+
/// ctx.modify(&evt, WatchingEvents::empty().set_write(), 2)
493+
/// .unwrap();
491494
/// ```
492495
pub fn modify(&self, fd: &dyn AsRawFd, events: WatchingEvents, token: T) -> Result<()> {
493496
let mut evt = epoll_event {
@@ -600,16 +603,20 @@ impl<T: PollToken> EpollContext<T> {
600603
/// ```
601604
/// extern crate vmm_sys_util;
602605
/// # use std::time::Duration;
603-
/// use vmm_sys_util::poll::{EpollContext, EpollEvents};
604606
/// use vmm_sys_util::eventfd::EventFd;
607+
/// use vmm_sys_util::poll::{EpollContext, EpollEvents};
605608
///
606609
/// let evt = EventFd::new(0).unwrap();
607610
/// let ctx: EpollContext<u32> = EpollContext::new().unwrap();
608611
/// let events = EpollEvents::new();
609612
///
610613
/// evt.write(1).unwrap();
611614
/// ctx.add(&evt, 1).unwrap();
612-
/// for event in ctx.wait_timeout(&events, Duration::new(100, 0)).unwrap().iter_readable() {
615+
/// for event in ctx
616+
/// .wait_timeout(&events, Duration::new(100, 0))
617+
/// .unwrap()
618+
/// .iter_readable()
619+
/// {
613620
/// assert_eq!(event.token(), 1);
614621
/// }
615622
/// ```

src/linux/signal.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,9 @@ pub fn register_signal_handler(num: c_int, handler: SignalHandler) -> errno::Res
202202
///
203203
/// let sigset = create_sigset(&[1]).unwrap();
204204
///
205-
/// unsafe { assert_eq!(sigismember(&sigset, 1), 1); }
205+
/// unsafe {
206+
/// assert_eq!(sigismember(&sigset, 1), 1);
207+
/// }
206208
/// ```
207209
pub fn create_sigset(signals: &[c_int]) -> errno::Result<sigset_t> {
208210
// sigset will actually be initialized by sigemptyset below.
@@ -356,7 +358,9 @@ pub fn unblock_signal(num: c_int) -> SignalResult<()> {
356358
/// assert_eq!(sigismember(&chkset, 1), 1);
357359
/// }
358360
/// });
359-
/// unsafe { pthread_kill(killable.pthread_handle(), 1); }
361+
/// unsafe {
362+
/// pthread_kill(killable.pthread_handle(), 1);
363+
/// }
360364
/// clear_signal(1).unwrap();
361365
/// ```
362366
pub fn clear_signal(num: c_int) -> SignalResult<()> {

src/linux/sock_ctrl_msg.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ unsafe fn raw_recvmsg(
296296
/// ```
297297
/// # extern crate libc;
298298
/// extern crate vmm_sys_util;
299-
/// use vmm_sys_util::sock_ctrl_msg::{ScmSocket};
299+
/// use vmm_sys_util::sock_ctrl_msg::ScmSocket;
300300
/// # use vmm_sys_util::eventfd::{EventFd, EFD_NONBLOCK};
301301
/// # use std::fs::File;
302302
/// # use std::io::Write;

src/unix/tempdir.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ impl TempDir {
109109
/// # use vmm_sys_util::tempdir::TempDir;
110110
/// let temp_dir = TempDir::new_with_prefix("/tmp/testdir").unwrap();
111111
/// temp_dir.remove().unwrap();
112-
///
113112
pub fn remove(&self) -> Result<()> {
114113
fs::remove_dir_all(&self.path).map_err(Error::from)
115114
}
@@ -124,7 +123,6 @@ impl TempDir {
124123
/// # use vmm_sys_util::tempdir::TempDir;
125124
/// let temp_dir = TempDir::new_with_prefix("/tmp/testdir").unwrap();
126125
/// assert!(temp_dir.as_path().exists());
127-
///
128126
pub fn as_path(&self) -> &Path {
129127
self.path.as_ref()
130128
}

0 commit comments

Comments
 (0)