kemitix/kxio
1
0
Fork 0
Code Issues 1 Pull requests 1 Releases 13 Activity Actions

doc(fs): minor tidy up broken links

Browse source
This commit is contained in:
Paul Campbell 2024-11-09 20:45:05 +00:00
parent f1cfae7153
commit e4c695501c
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/fs/mod.rs
View file

@ -1,10 +1,10 @@
//! Provides an injectable reference to part of the filesystem. //! Provides an injectable reference to part of the filesystem.
//! //!
//! Create a new `FileSystem` to access a directory using `kxio::fs::new(path)`. //! Create a new [FileSystem] to access a directory using [crate::fs::new].
//! Create a new `TempFileSystem` to access a temporary directory using `kxio::fs::temp()?`; //! Create a new [TempFileSystem] to access a temporary directory using [crate::fs::temp()].
//! //!
//! `TempFileSystem` derefs automatically to `FileSystem` so can be used anywhere //! [TempFileSystem] derefs automatically to [FileSystem] so can be used anywhere
//! you would use `FileSystem`. //! you would use [FileSystem].
//! //!
//! ``` //! ```
//! # use std::path::PathBuf; //! # use std::path::PathBuf;
@ -29,12 +29,12 @@
//! //!
//! # Standard library equivalents //! # Standard library equivalents
//! //!
//! Given a `FileSystem` `fs`: //! Given a [FileSystem] `fs`:
//! //!
//! ```no_run //! ```no_run
//! let fs = kxio::fs::temp().expect("temp fs"); // for testing //! let fs = kxio::fs::temp().expect("temp fs"); // for testing
//! // or //! // or
//! # let pathbuf = fs.base().join("foo").to_path_buf(); //! # let pathbuf = fs.base().join("foo");
//! let fs = kxio::fs::new(pathbuf); //! let fs = kxio::fs::new(pathbuf);
//! ``` //! ```
//! //!
@ -68,7 +68,7 @@ mod system;
mod temp; mod temp;
pub use dir_item::{DirItem, DirItemIterator}; pub use dir_item::{DirItem, DirItemIterator};
pub use path::{PathReal, PathMarker, FileMarker, DirMarker}; pub use path::{DirMarker, FileMarker, PathMarker, PathReal};
pub use reader::Reader; pub use reader::Reader;
pub use result::{Error, Result}; pub use result::{Error, Result};
pub use system::{DirHandle, FileHandle, FileSystem, PathHandle}; pub use system::{DirHandle, FileHandle, FileSystem, PathHandle};