From 1e8c6ccacb1dcdba94c169fee64b5b09092849c6 Mon Sep 17 00:00:00 2001 From: TechiePi Date: Sun, 10 Jul 2022 21:33:27 +0200 Subject: [PATCH] Fix issues with ``Fs`` docs --- ctru-rs/src/services/fs.rs | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/ctru-rs/src/services/fs.rs b/ctru-rs/src/services/fs.rs index 4ff6355..d86cb55 100644 --- a/ctru-rs/src/services/fs.rs +++ b/ctru-rs/src/services/fs.rs @@ -91,7 +91,7 @@ pub struct Fs(()); /// # Examples /// /// ```no_run -/// use ctru::services::fs::Fs +/// use ctru::services::fs::Fs; /// /// let fs = Fs::init().unwrap(); /// let sdmc_archive = fs.sdmc().unwrap(); @@ -116,14 +116,11 @@ pub struct Archive { /// use std::io::prelude::*; /// use ctru::services::fs::{Fs, File}; /// -/// # fn foo() -> std::io::Result<()> { /// let fs = Fs::init()?; /// let sdmc = fs.sdmc()?; /// /// let mut file = File::create(&sdmc, "/foo.txt")?; /// file.write_all(b"Hello, world!")?; -/// # Ok(()) -/// #} /// ``` /// /// Read the contents of a file into a `String`:: @@ -132,7 +129,6 @@ pub struct Archive { /// use std::io::prelude::*; /// use ctru::services::fs::{Fs, File}; /// -/// # fn foo() -> std::io::Result<()> { /// let fs = Fs::init()?; /// let sdmc = fs.sdmc()?; /// @@ -140,8 +136,6 @@ pub struct Archive { /// let mut contents = String::new(); /// file.read_to_string(&mut contents)?; /// assert_eq!(contents, "Hello, world!"); -/// # Ok(()) -/// #} /// ``` /// /// It can be more efficient to read the contents of a file with a buffered @@ -152,7 +146,6 @@ pub struct Archive { /// use std::io::prelude::*; /// use ctru::services::fs::{Fs, File}; /// -/// # fn foo() -> std::io::Result<()> { /// let fs = Fs::init()?; /// let sdmc = fs.sdmc()?; /// @@ -161,8 +154,6 @@ pub struct Archive { /// let mut contents = String::new(); /// buf_reader.read_to_string(&mut contents)?; /// assert_eq!(contents, "Hello, world!"); -/// # Ok(()) -/// # } /// ``` pub struct File { handle: u32, @@ -206,7 +197,7 @@ pub struct Metadata { /// Opening a file to read: /// /// ```no_run -/// use ctru::services::fs::OpenOptions; +/// use ctru::services::fs::{Fs, OpenOptions}; /// /// let fs = Fs::init().unwrap(); /// let sdmc_archive = fs.sdmc().unwrap(); @@ -221,7 +212,7 @@ pub struct Metadata { /// doesn't exist: /// /// ```no_run -/// use ctru::services::fs::OpenOptions; +/// use ctru::services::fs::{Fs, OpenOptions}; /// /// let fs = Fs::init().unwrap(); /// let sdmc_archive = fs.sdmc().unwrap(); @@ -350,8 +341,8 @@ impl File { /// ```no_run /// use ctru::services::fs::{Fs, File}; /// - /// let fs = Fs::init().unwrap() - /// let sdmc_archive = fs.sdmc().unwrap() + /// let fs = Fs::init().unwrap(); + /// let sdmc_archive = fs.sdmc().unwrap(); /// let mut f = File::open(&sdmc_archive, "/foo.txt").unwrap(); /// ``` pub fn open>(arch: &Archive, path: P) -> IoResult { @@ -379,8 +370,8 @@ impl File { /// ```no_run /// use ctru::services::fs::{Fs, File}; /// - /// let fs = Fs::init().unwrap() - /// let sdmc_archive = fs.sdmc().unwrap() + /// let fs = Fs::init().unwrap(); + /// let sdmc_archive = fs.sdmc().unwrap(); /// let mut f = File::create(&sdmc_archive, "/foo.txt").unwrap(); /// ``` pub fn create>(arch: &Archive, path: P) -> IoResult {