[][src]Struct sgx_tstd::path::Path

pub struct Path { /* fields omitted */ }

A slice of a path (akin to str).

This type supports a number of operations for inspecting a path, including breaking the path into its components (separated by / on Unix and by either / or \ on Windows), extracting the file name, determining whether the path is absolute, and so on.

This is an unsized type, meaning that it must always be used behind a pointer like & or Box. For an owned version of this type, see PathBuf.

More details about the overall approach can be found in the module documentation.

Methods

impl Path[src]

pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &Path[src]

Directly wraps a string slice as a Path slice.

This is a cost-free conversion.

pub fn as_os_str(&self) -> &OsStr[src]

Yields the underlying OsStr slice.

pub fn to_str(&self) -> Option<&str>[src]

Yields a &str slice if the Path is valid unicode.

This conversion may entail doing a check for UTF-8 validity. Note that validation is performed because non-UTF-8 strings are perfectly valid for some OS.

pub fn to_string_lossy(&self) -> Cow<str>[src]

Converts a Path to a Cow<str>.

Any non-Unicode sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

pub fn to_path_buf(&self) -> PathBuf[src]

Converts a Path to an owned PathBuf.

pub fn is_absolute(&self) -> bool[src]

Returns true if the Path is absolute, i.e., if it is independent of the current directory.

  • On Unix, a path is absolute if it starts with the root, so is_absolute and [has_root] are equivalent.

  • On Windows, a path is absolute if it has a prefix and starts with the root: c:\windows is absolute, while c:temp and \temp are not.

pub fn is_relative(&self) -> bool[src]

Returns true if the Path is relative, i.e., not absolute.

See [is_absolute]'s documentation for more details.

pub fn has_root(&self) -> bool[src]

Returns true if the Path has a root.

  • On Unix, a path has a root if it begins with /.

  • On Windows, a path has a root if it:

    • has no prefix and begins with a separator, e.g., \windows
    • has a prefix followed by a separator, e.g., c:\windows but not c:windows
    • has any non-disk prefix, e.g., \\server\share

pub fn parent(&self) -> Option<&Path>[src]

Returns the Path without its final component, if there is one.

Returns None if the path terminates in a root or prefix.

pub fn ancestors(&self) -> Ancestors[src]

Produces an iterator over Path and its ancestors.

The iterator will yield the Path that is returned if the [parent] method is used zero or more times. That means, the iterator will yield &self, &self.parent().unwrap(), &self.parent().unwrap().parent().unwrap() and so on. If the [parent] method returns None, the iterator will do likewise. The iterator will always yield at least one value, namely &self.

pub fn file_name(&self) -> Option<&OsStr>[src]

Returns the final component of the Path, if there is one.

If the path is a normal file, this is the file name. If it's the path of a directory, this is the directory name.

Returns None if the path terminates in ...

pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError> where
    P: AsRef<Path>, 
[src]

Returns a path that, when joined onto base, yields self.

Errors

If base is not a prefix of self (i.e., starts_with returns false), returns Err.

pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool[src]

Determines whether base is a prefix of self.

Only considers whole path components to match.

pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool[src]

Determines whether child is a suffix of self.

Only considers whole path components to match.

pub fn file_stem(&self) -> Option<&OsStr>[src]

Extracts the stem (non-extension) portion of self.file_name.

The stem is:

  • None, if there is no file name;
  • The entire file name if there is no embedded .;
  • The entire file name if the file name begins with . and has no other .s within;
  • Otherwise, the portion of the file name before the final .

pub fn extension(&self) -> Option<&OsStr>[src]

Extracts the extension of self.file_name, if possible.

The extension is:

  • None, if there is no file name;
  • None, if there is no embedded .;
  • None, if the file name begins with . and has no other .s within;
  • Otherwise, the portion of the file name after the final .

pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf[src]

Creates an owned PathBuf with path adjoined to self.

See PathBuf::push for more details on what it means to adjoin a path.

pub fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> PathBuf[src]

Creates an owned PathBuf like self but with the given file name.

See PathBuf::set_file_name for more details.

pub fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> PathBuf[src]

Creates an owned PathBuf like self but with the given extension.

See PathBuf::set_extension for more details.

pub fn components(&self) -> Components[src]

Produces an iterator over the Components of the path.

When parsing the path, there is a small amount of normalization:

  • Repeated separators are ignored, so a/b and a//b both have a and b as components.

  • Occurrences of . are normalized away, except if they are at the beginning of the path. For example, a/./b, a/b/, a/b/. and a/b all have a and b as components, but ./a/b starts with an additional [CurDir] component.

  • A trailing slash is normalized away, /a/b and /a/b/ are equivalent.

Note that no other normalization takes place; in particular, a/c and a/b/../c are distinct, to account for the possibility that b is a symbolic link (so its parent isn't a).

pub fn iter(&self) -> Iter[src]

Produces an iterator over the path's components viewed as OsStr slices.

For more information about the particulars of how the path is separated into components, see components.

pub fn display(&self) -> Display[src]

Returns an object that implements Display for safely printing paths that may contain non-Unicode data.

pub fn into_path_buf(self: Box<Path>) -> PathBuf[src]

Converts a Box<Path> into a PathBuf without copying or allocating.

Trait Implementations

impl AsRef<OsStr> for Path[src]

impl<'_> AsRef<Path> for Component<'_>[src]

impl<'_> AsRef<Path> for Components<'_>[src]

impl<'_> AsRef<Path> for Iter<'_>[src]

impl AsRef<Path> for Path[src]

impl AsRef<Path> for OsStr[src]

impl<'_> AsRef<Path> for Cow<'_, OsStr>[src]

impl AsRef<Path> for OsString[src]

impl AsRef<Path> for str[src]

impl AsRef<Path> for String[src]

impl AsRef<Path> for PathBuf[src]

impl Borrow<Path> for PathBuf[src]

impl Debug for Path[src]

impl Eq for Path[src]

impl<'_> From<&'_ Path> for Box<Path>[src]

impl<'_> From<&'_ Path> for Arc<Path>[src]

fn from(s: &Path) -> Arc<Path>[src]

Converts a Path into an Arc by copying the Path data into a new Arc buffer.

impl<'_> From<&'_ Path> for Rc<Path>[src]

fn from(s: &Path) -> Rc<Path>[src]

Converts a Path into an Rc by copying the Path data into a new Rc buffer.

impl<'a> From<&'a Path> for Cow<'a, Path>[src]

impl Hash for Path[src]

impl<'a> IntoIterator for &'a Path[src]

type Item = &'a OsStr

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

impl Ord for Path[src]

impl<'a, 'b> PartialEq<&'a OsStr> for Path[src]

impl<'a, 'b> PartialEq<&'a Path> for PathBuf[src]

impl<'a, 'b> PartialEq<&'a Path> for OsStr[src]

impl<'a, 'b> PartialEq<&'a Path> for Cow<'b, OsStr>[src]

impl<'a, 'b> PartialEq<&'a Path> for OsString[src]

impl<'a, 'b> PartialEq<&'b Path> for Cow<'a, Path>[src]

impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for Path[src]

impl<'a, 'b> PartialEq<Cow<'a, Path>> for Path[src]

impl<'a, 'b> PartialEq<Cow<'a, Path>> for &'b Path[src]

impl<'a, 'b> PartialEq<Cow<'b, OsStr>> for &'a Path[src]

impl<'a, 'b> PartialEq<OsStr> for Path[src]

impl<'a, 'b> PartialEq<OsStr> for &'a Path[src]

impl<'a, 'b> PartialEq<OsString> for Path[src]

impl<'a, 'b> PartialEq<OsString> for &'a Path[src]

impl PartialEq<Path> for Path[src]

impl<'a, 'b> PartialEq<Path> for PathBuf[src]

impl<'a, 'b> PartialEq<Path> for Cow<'a, Path>[src]

impl<'a, 'b> PartialEq<Path> for OsStr[src]

impl<'a, 'b> PartialEq<Path> for &'a OsStr[src]

impl<'a, 'b> PartialEq<Path> for Cow<'a, OsStr>[src]

impl<'a, 'b> PartialEq<Path> for OsString[src]

impl<'a, 'b> PartialEq<PathBuf> for Path[src]

impl<'a, 'b> PartialEq<PathBuf> for &'a Path[src]

impl<'a, 'b> PartialOrd<&'a OsStr> for Path[src]

impl<'a, 'b> PartialOrd<&'a Path> for PathBuf[src]

impl<'a, 'b> PartialOrd<&'a Path> for OsStr[src]

impl<'a, 'b> PartialOrd<&'a Path> for Cow<'b, OsStr>[src]

impl<'a, 'b> PartialOrd<&'a Path> for OsString[src]

impl<'a, 'b> PartialOrd<&'b Path> for Cow<'a, Path>[src]

impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for Path[src]

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for Path[src]

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for &'b Path[src]

impl<'a, 'b> PartialOrd<Cow<'b, OsStr>> for &'a Path[src]

impl<'a, 'b> PartialOrd<OsStr> for Path[src]

impl<'a, 'b> PartialOrd<OsStr> for &'a Path[src]

impl<'a, 'b> PartialOrd<OsString> for Path[src]

impl<'a, 'b> PartialOrd<OsString> for &'a Path[src]

impl PartialOrd<Path> for Path[src]

impl<'a, 'b> PartialOrd<Path> for PathBuf[src]

impl<'a, 'b> PartialOrd<Path> for Cow<'a, Path>[src]

impl<'a, 'b> PartialOrd<Path> for OsStr[src]

impl<'a, 'b> PartialOrd<Path> for &'a OsStr[src]

impl<'a, 'b> PartialOrd<Path> for Cow<'a, OsStr>[src]

impl<'a, 'b> PartialOrd<Path> for OsString[src]

impl<'a, 'b> PartialOrd<PathBuf> for Path[src]

impl<'a, 'b> PartialOrd<PathBuf> for &'a Path[src]

impl PathEx for Path[src]

fn metadata(&self) -> Result<Metadata>[src]

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 is an alias to fs::metadata.

Queries the metadata about a file without following symlinks.

This is an alias to fs::symlink_metadata.

fn canonicalize(&self) -> Result<PathBuf>[src]

Returns the canonical form of the path with all intermediate components normalized and symbolic links resolved.

This is an alias to fs::canonicalize.

Reads a symbolic link, returning the file that the link points to.

This is an alias to fs::read_link.

fn exists(&self) -> bool[src]

Returns whether the path points at an existing entity.

This function will traverse symbolic links to query information about the destination file. In case of broken symbolic links this will return false.

If you cannot access the directory containing the file, e.g. because of a permission error, this will return false.

fn is_file(&self) -> bool[src]

Returns whether the path exists on disk and is pointing at a regular file.

This function will traverse symbolic links to query information about the destination file. In case of broken symbolic links this will return false.

If you cannot access the directory containing the file, e.g. because of a permission error, this will return false.

fn is_dir(&self) -> bool[src]

Returns whether the path exists on disk and is pointing at a directory.

This function will traverse symbolic links to query information about the destination file. In case of broken symbolic links this will return false.

If you cannot access the directory containing the file, e.g. because of a permission error, this will return false.

impl ToOwned for Path[src]

type Owned = PathBuf

The resulting type after obtaining ownership.

Auto Trait Implementations

impl RefUnwindSafe for Path

impl Send for Path

impl Sync for Path

impl Unpin for Path

impl UnwindSafe for Path

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.