[−][src]Struct abscissa_core::path::AbsPathBuf
An owned path on the filesystem which is guaranteed to be canonical.
More specifically: it is at least guaranteed to be canonical at the time it is created. There are potential TOCTTOU problems if the underlying filesystem structure changes after path canonicalization.
Methods
impl CanonicalPathBuf
[src]
pub fn canonicalize<P>(path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Create a canonical path by first canonicalizing the given path.
pub fn new<P>(path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Create a canonical path, returning error if the supplied path is not canonical.
pub fn as_canonical_path(&self) -> &CanonicalPath
[src]
Return a CanonicalPath
reference.
pub fn set_file_name<S>(&mut self, file_name: S) where
S: AsRef<OsStr>,
[src]
S: AsRef<OsStr>,
Updates self
's filename ala the same method on PathBuf
pub fn set_extension<S>(&mut self, extension: S) -> bool where
S: AsRef<OsStr>,
[src]
S: AsRef<OsStr>,
Updates self.extension
to extension.
Returns false
and does nothing if self.file_name
is None
,
returns true
and updates the extension otherwise.
If self.extension
is None
, the extension is added; otherwise it is replaced.
pub fn into_path_buf(self) -> PathBuf
[src]
Consumes the CanonicalPathBuf
, yielding its internal PathBuf
storage.
pub fn into_os_string(self) -> OsString
[src]
Consumes the CanonicalPathBuf
, yielding its internal OsString
storage.
pub fn as_path(&self) -> &Path
[src]
Return a Path
reference.
pub fn as_os_str(&self) -> &OsStr
[src]
Return an OsStr
reference.
pub fn to_str(&self) -> Option<&str>
[src]
Yields a &str
slice if the path is valid unicode.
pub fn parent(&self) -> Result<CanonicalPathBuf, Error>
[src]
Return a canonical parent path of this path, or io::Error
if the
path is the root directory or another canonicalization error occurs.
pub fn file_name(&self) -> Option<&OsStr>
[src]
Returns the final component of the path, if there is one.
pub fn starts_with<P>(&self, base: P) -> bool where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Determines whether base is a prefix of self.
pub fn ends_with<P>(&self, child: P) -> bool where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Determines whether child is a suffix of self.
pub fn file_stem(&self) -> Option<&OsStr>
[src]
Extracts the stem (non-extension) portion of self.file_name
.
pub fn extension(&self) -> Option<&OsStr>
[src]
Extracts the extension of self.file_name
, if possible.
pub fn with_file_name<S>(&self, file_name: S) -> Result<CanonicalPathBuf, Error> where
S: AsRef<OsStr>,
[src]
S: AsRef<OsStr>,
Creates an owned CanonicalPathBuf
like self but with the given file name.
pub fn with_extension<S>(&self, extension: S) -> Result<CanonicalPathBuf, Error> where
S: AsRef<OsStr>,
[src]
S: AsRef<OsStr>,
Creates an owned CanonicalPathBuf
like self but with the given extension.
pub fn components(&self) -> Components
[src]
Produces an iterator over the Component
s of a path
pub fn iter(&self) -> Iter
[src]
Produces an iterator over the path's components viewed as
OsStr
slices.
pub fn display(&self) -> Display
[src]
Returns an object that implements Display
for safely printing
paths that may contain non-Unicode data.
pub fn metadata(&self) -> Result<Metadata, Error>
[src]
Queries the file system to get information about a file, directory, etc.
Unlike the std
version of this method, it will not follow symlinks,
since as a canonical path we should be symlink-free.
pub fn join<P>(&self, path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Join a path onto a canonical path, returning a CanonicalPathBuf
.
pub fn read_dir(&self) -> Result<ReadDir, Error>
[src]
Returns an iterator over the entries within a directory.
The iterator will yield instances of io::Result
This is an alias to fs::read_dir.
pub fn exists(&self) -> bool
[src]
Does this path exist?
pub fn is_file(&self) -> bool
[src]
Is this path a file?
pub fn is_dir(&self) -> bool
[src]
Is this path a directory?
Trait Implementations
impl Borrow<CanonicalPath> for CanonicalPathBuf
[src]
fn borrow(&self) -> &CanonicalPath
[src]
impl PartialEq<CanonicalPathBuf> for CanonicalPathBuf
[src]
fn eq(&self, other: &CanonicalPathBuf) -> bool
[src]
fn ne(&self, other: &CanonicalPathBuf) -> bool
[src]
impl Hash for CanonicalPathBuf
[src]
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Debug for CanonicalPathBuf
[src]
impl Ord for CanonicalPathBuf
[src]
fn cmp(&self, other: &CanonicalPathBuf) -> Ordering
[src]
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
[src]
clamp
)Restrict a value to a certain interval. Read more
impl Clone for CanonicalPathBuf
[src]
fn clone(&self) -> CanonicalPathBuf
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialOrd<CanonicalPathBuf> for CanonicalPathBuf
[src]
fn partial_cmp(&self, other: &CanonicalPathBuf) -> Option<Ordering>
[src]
fn lt(&self, other: &CanonicalPathBuf) -> bool
[src]
fn le(&self, other: &CanonicalPathBuf) -> bool
[src]
fn gt(&self, other: &CanonicalPathBuf) -> bool
[src]
fn ge(&self, other: &CanonicalPathBuf) -> bool
[src]
impl AsRef<OsStr> for CanonicalPathBuf
[src]
impl AsRef<CanonicalPath> for CanonicalPathBuf
[src]
fn as_ref(&self) -> &CanonicalPath
[src]
impl AsRef<Path> for CanonicalPathBuf
[src]
impl Eq for CanonicalPathBuf
[src]
Auto Trait Implementations
impl Sync for CanonicalPathBuf
impl Unpin for CanonicalPathBuf
impl Send for CanonicalPathBuf
impl UnwindSafe for CanonicalPathBuf
impl RefUnwindSafe for CanonicalPathBuf
Blanket Implementations
impl<T> AsAny for T where
T: Any,
[src]
T: Any,
fn as_any(&Self) -> &(dyn Any + 'static)
[src]
fn as_mut_any(&mut Self) -> &mut (dyn Any + 'static)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,