pub struct PathAbs(/* private fields */);Expand description
An absolute (not necessarily canonicalized) path that may or may not exist.
Implementations§
Source§impl PathAbs
impl PathAbs
Sourcepub fn new<P: AsRef<Path>>(path: P) -> Result<PathAbs>
pub fn new<P: AsRef<Path>>(path: P) -> Result<PathAbs>
Construct an absolute path from an arbitrary (absolute or relative) one.
This is different from canonicalize in that it preserves symlinks
and the destination may or may not exist.
This function will:
- Resolve relative paths against the current working directory.
- Strip any
.components (/a/./c->/a/c) - Resolve
..semantically (not using the file system). So,a/b/c/../d => a/b/dwill always be true regardless of symlinks. If you want symlinks correctly resolved, usecanonicalize()instead.
On windows, this will sometimes call
canonicalize()on the first component to guarantee it is the correct canonicalized prefix. For paths starting with root it also has to get thecurrent_dir
On linux, the only syscall this will make is to get the
current_dirfor relative paths.
§Examples
use path_abs::{PathAbs, PathInfo};
let lib = PathAbs::new("src/lib.rs")?;
assert_eq!(lib.is_absolute(), true);Sourcepub fn new_unchecked<P: Into<Arc<PathBuf>>>(path: P) -> PathAbs
pub fn new_unchecked<P: Into<Arc<PathBuf>>>(path: P) -> PathAbs
Create a PathAbs unchecked.
This is mostly used for constructing during tests, or if the path was previously validated.
This is effectively the same as a Arc<PathBuf>.
Note: This is memory safe, so is not marked
unsafe. However, it could cause panics in some methods if the path was not properly validated.
Trait Implementations§
Source§impl<'de> Deserialize<'de> for PathAbs
impl<'de> Deserialize<'de> for PathAbs
Source§fn deserialize<D>(deserializer: D) -> Result<PathAbs, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<PathAbs, D::Error>where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl Ord for PathAbs
impl Ord for PathAbs
Source§impl PartialOrd for PathAbs
impl PartialOrd for PathAbs
Source§impl PathMut for PathAbs
impl PathMut for PathAbs
Source§fn append<P: AsRef<Path>>(&mut self, path: P) -> Result<()>
fn append<P: AsRef<Path>>(&mut self, path: P) -> Result<()>
Appends
path to this path. Read moreSource§fn truncate_to_root(&mut self)
fn truncate_to_root(&mut self)
Removes all components after the root, if any. Read more
fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S)
fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool
Source§impl PathOps for PathAbs
impl PathOps for PathAbs
type Output = PathAbs
Source§fn concat<P: AsRef<Path>>(&self, path: P) -> Result<Self::Output>
fn concat<P: AsRef<Path>>(&self, path: P) -> Result<Self::Output>
Returns a new value representing the concatenation of two paths. Read more
Source§fn join<P: AsRef<Path>>(&self, path: P) -> Self::Output
fn join<P: AsRef<Path>>(&self, path: P) -> Self::Output
An exact replica of
std::path::Path::join with all of its gotchas and pitfalls,, except
returns a more relevant type. Read moreimpl Eq for PathAbs
impl StructuralPartialEq for PathAbs
Auto Trait Implementations§
impl Freeze for PathAbs
impl RefUnwindSafe for PathAbs
impl Send for PathAbs
impl Sync for PathAbs
impl Unpin for PathAbs
impl UnwindSafe for PathAbs
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit)Source§impl<T> PathInfo for T
impl<T> PathInfo for T
fn as_path(&self) -> &Path
fn to_arc_pathbuf(&self) -> Arc<PathBuf>
fn as_os_str(&self) -> &OsStr
fn to_str(&self) -> Option<&str>
fn to_string_lossy(&self) -> Cow<'_, str>
fn is_absolute(&self) -> bool
fn is_relative(&self) -> bool
fn has_root(&self) -> bool
fn ancestors(&self) -> Ancestors<'_>
fn file_name(&self) -> Option<&OsStr>
fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>
fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool
fn ends_with<P: AsRef<Path>>(&self, base: P) -> bool
fn file_stem(&self) -> Option<&OsStr>
fn extension(&self) -> Option<&OsStr>
fn components(&self) -> Components<'_>
fn iter(&self) -> Iter<'_>
fn display(&self) -> Display<'_>
Source§fn metadata(&self) -> Result<Metadata>
fn metadata(&self) -> Result<Metadata>
Queries the file system to get information about a file, directory, etc. Read more
Source§fn symlink_metadata(&self) -> Result<Metadata>
fn symlink_metadata(&self) -> Result<Metadata>
Queries the metadata about a file without following symlinks. Read more
fn exists(&self) -> bool
fn is_file(&self) -> bool
fn is_dir(&self) -> bool
Source§fn read_link(&self) -> Result<PathBuf>
fn read_link(&self) -> Result<PathBuf>
Reads a symbolic link, returning the path that the link points to. Read more