1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
/* Copyright (c) 2018 Garrett Berg, vitiral@gmail.com * * Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or * http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or * http://opensource.org/licenses/MIT>, at your option. This file may not be * copied, modified, or distributed except according to those terms. */ //! `PathArc`: Atomically reference counted path with better errors. use std::fmt; use std::fs; use std::ffi::OsStr; use std_prelude::*; use super::{Error, Result}; use abs::PathAbs; use dir::{ListDir, PathDir}; #[derive(Clone, Eq, Hash, PartialEq, PartialOrd, Ord)] /// A `PathBuf` that is atomically reference counted and reimplements the `PathBuf` /// methods to display the action and path when there is an error. /// /// This is the root type of all other `Path*` types in this crate. /// /// This type is also serializable when the `serialize` feature is enabled. pub struct PathArc(pub(crate) Arc<PathBuf>); impl PathArc { /// Instantiate a new `PathArc`. /// /// # Examples /// ```rust /// # extern crate path_abs; /// use path_abs::PathArc; /// /// # fn try_main() -> ::std::io::Result<()> { /// let path = PathArc::new("some/path"); /// let path2 = path.clone(); // cloning is cheap /// # Ok(()) } fn main() { try_main().unwrap() } /// ``` pub fn new<P: AsRef<Path>>(path: P) -> PathArc { PathArc::from(path.as_ref().to_path_buf()) } /// Creates an owned PathBuf with path adjoined to self. /// /// This function is identical to [std::path::PathBuf::join][0] except /// it returns `PathArc` instead of `PathBuf` /// /// [0]: https://doc.rust-lang.org/std/path/struct.PathBuf.html#method.join pub fn join<P: AsRef<Path>>(&self, path: P) -> PathArc { PathArc::from(self.0.join(path)) } /// Creates an owned `PathArc` like self but with the given file name. /// /// This function is identical to [std::path::PathBuf::with_file_name][0] except /// it returns `PathArc` instead of `PathBuf` /// /// [0]: https://doc.rust-lang.org/std/path/struct.PathBuf.html#method.with_file_name pub fn with_file_name<P: AsRef<OsStr>>(&self, file_name: P) -> PathArc { PathArc::from(self.0.with_file_name(file_name)) } /// Creates an owned `PathArc` like self but with the given extension. /// /// This function is identical to [std::path::PathBuf::with_extension][0] except /// it returns `PathArc` instead of `PathBuf` /// /// [0]: https://doc.rust-lang.org/std/path/struct.PathBuf.html#method.with_extension pub fn with_extension<P: AsRef<OsStr>>(&self, extension: P) -> PathArc { PathArc::from(self.0.with_extension(extension)) } /// Queries the file system to get information about a file, directory, etc. /// /// This function will traverse symbolic links to query information about the destination file. /// /// This function is identical to [std::path::Path::metadata][0] except it has error /// messages which include the action and the path /// /// [0]: https://doc.rust-lang.org/std/path/struct.Path.html#method.metadata pub fn metadata(&self) -> Result<fs::Metadata> { self.0 .metadata() .map_err(|err| Error::new(err, "getting metadata of", self.clone())) } /// Queries the metadata about a file without following symlinks. /// /// This function is identical to [std::path::Path::symlink_metadata][0] except it has error /// messages which include the action and the path /// /// [0]: https://doc.rust-lang.org/std/path/struct.Path.html#method.symlink_metadata pub fn symlink_metadata(&self) -> Result<fs::Metadata> { self.0 .symlink_metadata() .map_err(|err| Error::new(err, "getting symlink_metadata of", self.clone())) } /// Returns the canonical form of the path with all intermediate components normalized and /// symbolic links resolved. /// /// > This is identical to `PathAbs::new(path)`. /// /// This function is identical to [std::path::Path::canonicalize][0] except: /// - It returns a `PathAbs` object /// - It has error messages which include the action and the path /// /// [0]: https://doc.rust-lang.org/std/path/struct.Path.html#method.canonicalize pub fn canonicalize(&self) -> Result<PathAbs> { let abs = self.0 .canonicalize() .map_err(|err| Error::new(err, "canonicalizing", self.clone()))?; Ok(PathAbs(PathArc::from(abs))) } /// Reads a symbolic link, returning the file that the link points to. /// /// This function is identical to [std::path::Path::read_link][0] except: /// - It returns a `PathArc` object instead of `PathBuf` /// - It has error messages which include the action and the path /// /// [0]: https://doc.rust-lang.org/std/path/struct.Path.html#method.read_link pub fn read_link(&self) -> Result<PathArc> { let path = self.0 .read_link() .map_err(|err| Error::new(err, "reading link", self.clone()))?; Ok(PathArc::from(path)) } /// Returns an iterator over the entries within a directory. /// /// This function is a shortcut to `PathDir::list`. It is slightly different /// than [std::path::Path::read_dir][0]. /// /// [0]: https://doc.rust-lang.org/std/path/struct.Path.html#method.read_dir pub fn read_dir(&self) -> Result<ListDir> { let dir = PathDir::new(self)?; dir.list() } /// Return a reference to a basic `std::path::Path` pub fn as_path(&self) -> &Path { self.as_ref() } } impl fmt::Debug for PathArc { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { self.0.fmt(f) } } impl AsRef<PathBuf> for PathArc { fn as_ref(&self) -> &PathBuf { &self.0 } } impl AsRef<Path> for PathArc { fn as_ref(&self) -> &Path { self.0.as_path() } } impl Deref for PathArc { type Target = PathBuf; fn deref(&self) -> &PathBuf { &self.0 } } impl From<PathBuf> for PathArc { /// Instantiate a new `PathArc` from a `PathBuf`. fn from(path: PathBuf) -> PathArc { PathArc(Arc::new(path)) } } impl Into<PathBuf> for PathArc { /// If there is only one reference to the `PathArc`, returns /// the inner `PathBuf`. Otherwise clones the inner `PathBuf`. /// /// This is useful when you really want a `PathBuf`, especially /// when the `PathArc` was only recently created. /// /// # Examples /// ``` /// # extern crate path_abs; /// use path_abs::PathArc; /// use std::path::PathBuf; /// /// # fn try_main() -> ::std::io::Result<()> { /// let base = PathArc::new("base"); /// let foo: PathBuf = base.join("foo.txt").into(); /// # Ok(()) } fn main() { try_main().unwrap() } /// ``` fn into(self) -> PathBuf { match Arc::try_unwrap(self.0) { Ok(p) => p, Err(inner) => inner.as_ref().clone(), } } }