Struct TempDir

Source
pub struct TempDir { /* private fields */ }
Expand description

A named temporary directory that will be cleaned automatically after the last reference to it is dropped.

Implementations§

Source§

impl TempDir

Source

pub async fn new() -> Result<Self, Error>

Creates a new temporary directory in the default location. When the instance goes out of scope, the directory will be deleted.

§Example
let dir = TempDir::new().await?;

// The file exists.
let dir_path = dir.dir_path().clone();
assert!(fs::metadata(dir_path.clone()).await.is_ok());

// Deletes the directory.
drop(dir);

// The directory was removed.
assert!(fs::metadata(dir_path).await.is_err());
Source

pub async fn new_with_name<N: AsRef<str>>(name: N) -> Result<Self, Error>

Creates a new temporary directory in the default location. When the instance goes out of scope, the directory will be deleted.

§Arguments
  • name - The name of the directory to create in the default temporary directory root.
§Example
let dir = TempDir::new_with_name("temporary.dir").await?;

// The directory exists.
let dir_path = dir.dir_path().clone();
assert!(fs::metadata(dir_path.clone()).await.is_ok());

// Deletes the directory.
drop(dir);

// The directory was removed.
assert!(fs::metadata(dir_path).await.is_err());
Source

pub async fn new_with_uuid(uuid: Uuid) -> Result<Self, Error>

Available on crate feature uuid only.

Creates a new temporary directory in the default location. When the instance goes out of scope, the directory will be deleted.

§Arguments
  • uuid - A UUID to use as a suffix to the directory name.
§Example
let id = uuid::Uuid::new_v4();
let dir = TempDir::new_with_uuid(id).await?;

// The directory exists.
let dir_path = dir.dir_path().clone();
assert!(fs::metadata(dir_path.clone()).await.is_ok());

// Deletes the directory.
drop(dir);

// The directory was removed.
assert!(fs::metadata(dir_path).await.is_err());
Source

pub async fn new_in<P: Borrow<Path>>(root_dir: P) -> Result<Self, Error>

Creates a new temporary directory in the specified location. When the instance goes out of scope, the directory will be deleted.

§Crate Features
  • uuid - When the uuid crate feature is enabled, a random UUIDv4 is used to generate the temporary directory name.
§Arguments
  • dir - The directory to create the directory in.
§Example
let path = std::env::temp_dir();
let dir = TempDir::new_in(path).await?;

// The directory exists.
let dir_path = dir.dir_path().clone();
assert!(fs::metadata(dir_path.clone()).await.is_ok());

// Deletes the directory.
drop(dir);

// The directory was removed.
assert!(fs::metadata(dir_path).await.is_err());
Source

pub async fn new_with_name_in<N: AsRef<str>, P: Borrow<Path>>( name: N, root_dir: P, ) -> Result<Self, Error>

Creates a new temporary directory in the specified location. When the instance goes out of scope, the directory will be deleted.

§Arguments
  • dir - The root directory to create the directory in.
  • name - The directory name to use.
§Example
let path = std::env::temp_dir();
let dir = TempDir::new_with_name_in("temporary.dir", path).await?;

// The directory exists.
let dir_path = dir.dir_path().clone();
assert!(fs::metadata(dir_path.clone()).await.is_ok());

// Deletes the directory.
drop(dir);

// The directory was removed.
assert!(fs::metadata(dir_path).await.is_err());
Source

pub async fn new_with_uuid_in<P: Borrow<Path>>( uuid: Uuid, root_dir: P, ) -> Result<Self, Error>

Available on crate feature uuid only.

Creates a new directory file in the specified location. When the instance goes out of scope, the directory will be deleted.

§Arguments
  • dir - The root directory to create the directory in.
  • uuid - A UUID to use as a suffix to the directory name.
§Example
let path = std::env::temp_dir();
let id = uuid::Uuid::new_v4();
let dir = TempDir::new_with_uuid_in(id, path).await?;

// The directory exists.
let dir_path = dir.dir_path().clone();
assert!(fs::metadata(dir_path.clone()).await.is_ok());

// Deletes the directory.
drop(dir);

// The directory was removed.
assert!(fs::metadata(dir_path).await.is_err());
Source

pub async fn from_existing( path: PathBuf, ownership: Ownership, ) -> Result<Self, Error>

Wraps a new instance of this type around an existing directory. If ownership is set to Ownership::Borrowed, this method does not take ownership of the file, i.e. the directory will not be deleted when the instance is dropped.

§Arguments
  • path - The path of the directory to wrap.
  • ownership - The ownership of the directory.
Source

pub fn dir_path(&self) -> &PathBuf

Returns the path of the underlying temporary directory.

Source

pub async fn try_clone(&self) -> Result<TempDir, Error>

Creates a new TempDir instance that shares the same underlying file handle as the existing TempDir instance. Reads, writes, and seeks will affect both TempDir instances simultaneously.

Source

pub fn ownership(&self) -> Ownership

Determines the ownership of the temporary directory.

§Example
let dir = TempDir::new().await?;
assert_eq!(dir.ownership(), Ownership::Owned);
Source

pub async fn drop_async(self)

Asynchronously drops the TempDir instance by moving the drop operation to a blocking thread, avoiding potential blocking of the async runtime.

This method is useful in cases where manually handling the blocking drop within an async context is required.

§Example
let dir = TempDir::new().await?;

// Drop the directory asynchronously.
dir.drop_async().await;

// The directory is now removed.

Note: This function spawns a blocking task for the drop operation.

Methods from Deref<Target = Path>§

1.0.0 · Source

pub fn as_os_str(&self) -> &OsStr

Yields the underlying OsStr slice.

§Examples
use std::path::Path;

let os_str = Path::new("foo.txt").as_os_str();
assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));
1.0.0 · Source

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

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.

§Examples
use std::path::Path;

let path = Path::new("foo.txt");
assert_eq!(path.to_str(), Some("foo.txt"));
1.0.0 · Source

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts a Path to a Cow<str>.

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

§Examples

Calling to_string_lossy on a Path with valid unicode:

use std::path::Path;

let path = Path::new("foo.txt");
assert_eq!(path.to_string_lossy(), "foo.txt");

Had path contained invalid unicode, the to_string_lossy call might have returned "fo�.txt".

1.0.0 · Source

pub fn to_path_buf(&self) -> PathBuf

Converts a Path to an owned PathBuf.

§Examples
use std::path::{Path, PathBuf};

let path_buf = Path::new("foo.txt").to_path_buf();
assert_eq!(path_buf, PathBuf::from("foo.txt"));
1.0.0 · Source

pub fn is_absolute(&self) -> bool

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.

§Examples
use std::path::Path;

assert!(!Path::new("foo.txt").is_absolute());
1.0.0 · Source

pub fn is_relative(&self) -> bool

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

See is_absolute’s documentation for more details.

§Examples
use std::path::Path;

assert!(Path::new("foo.txt").is_relative());
1.0.0 · Source

pub fn has_root(&self) -> bool

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
§Examples
use std::path::Path;

assert!(Path::new("/etc/passwd").has_root());
1.0.0 · Source

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

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

This means it returns Some("") for relative paths with one component.

Returns None if the path terminates in a root or prefix, or if it’s the empty string.

§Examples
use std::path::Path;

let path = Path::new("/foo/bar");
let parent = path.parent().unwrap();
assert_eq!(parent, Path::new("/foo"));

let grand_parent = parent.parent().unwrap();
assert_eq!(grand_parent, Path::new("/"));
assert_eq!(grand_parent.parent(), None);

let relative_path = Path::new("foo/bar");
let parent = relative_path.parent();
assert_eq!(parent, Some(Path::new("foo")));
let grand_parent = parent.and_then(Path::parent);
assert_eq!(grand_parent, Some(Path::new("")));
let great_grand_parent = grand_parent.and_then(Path::parent);
assert_eq!(great_grand_parent, None);
1.28.0 · Source

pub fn ancestors(&self) -> Ancestors<'_>

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. If the parent method returns None, the iterator will do likewise. The iterator will always yield at least one value, namely Some(&self). Next it will yield &self.parent(), &self.parent().and_then(Path::parent) and so on.

§Examples
use std::path::Path;

let mut ancestors = Path::new("/foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));
assert_eq!(ancestors.next(), Some(Path::new("/foo")));
assert_eq!(ancestors.next(), Some(Path::new("/")));
assert_eq!(ancestors.next(), None);

let mut ancestors = Path::new("../foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Path::new("../foo/bar")));
assert_eq!(ancestors.next(), Some(Path::new("../foo")));
assert_eq!(ancestors.next(), Some(Path::new("..")));
assert_eq!(ancestors.next(), Some(Path::new("")));
assert_eq!(ancestors.next(), None);
1.0.0 · Source

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

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 ...

§Examples
use std::path::Path;
use std::ffi::OsStr;

assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
assert_eq!(None, Path::new("foo.txt/..").file_name());
assert_eq!(None, Path::new("/").file_name());
1.7.0 · Source

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

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.

§Examples
use std::path::{Path, PathBuf};

let path = Path::new("/test/haha/foo.txt");

assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));
assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));

assert!(path.strip_prefix("test").is_err());
assert!(path.strip_prefix("/te").is_err());
assert!(path.strip_prefix("/haha").is_err());

let prefix = PathBuf::from("/test/");
assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));
1.0.0 · Source

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

Determines whether base is a prefix of self.

Only considers whole path components to match.

§Examples
use std::path::Path;

let path = Path::new("/etc/passwd");

assert!(path.starts_with("/etc"));
assert!(path.starts_with("/etc/"));
assert!(path.starts_with("/etc/passwd"));
assert!(path.starts_with("/etc/passwd/")); // extra slash is okay
assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay

assert!(!path.starts_with("/e"));
assert!(!path.starts_with("/etc/passwd.txt"));

assert!(!Path::new("/etc/foo.rs").starts_with("/etc/foo"));
1.0.0 · Source

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

Determines whether child is a suffix of self.

Only considers whole path components to match.

§Examples
use std::path::Path;

let path = Path::new("/etc/resolv.conf");

assert!(path.ends_with("resolv.conf"));
assert!(path.ends_with("etc/resolv.conf"));
assert!(path.ends_with("/etc/resolv.conf"));

assert!(!path.ends_with("/resolv.conf"));
assert!(!path.ends_with("conf")); // use .extension() instead
1.0.0 · Source

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

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 .
§Examples
use std::path::Path;

assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap());
assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());
§See Also

This method is similar to Path::file_prefix, which extracts the portion of the file name before the first .

Source

pub fn file_prefix(&self) -> Option<&OsStr>

🔬This is a nightly-only experimental API. (path_file_prefix)

Extracts the prefix of self.file_name.

The prefix is:

  • None, if there is no file name;
  • The entire file name if there is no embedded .;
  • The portion of the file name before the first non-beginning .;
  • The entire file name if the file name begins with . and has no other .s within;
  • The portion of the file name before the second . if the file name begins with .
§Examples
use std::path::Path;

assert_eq!("foo", Path::new("foo.rs").file_prefix().unwrap());
assert_eq!("foo", Path::new("foo.tar.gz").file_prefix().unwrap());
§See Also

This method is similar to Path::file_stem, which extracts the portion of the file name before the last .

1.0.0 · Source

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

Extracts the extension (without the leading dot) 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 .
§Examples
use std::path::Path;

assert_eq!("rs", Path::new("foo.rs").extension().unwrap());
assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());
1.0.0 · Source

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

Creates an owned PathBuf with path adjoined to self.

If path is absolute, it replaces the current path.

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

§Examples
use std::path::{Path, PathBuf};

assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
assert_eq!(Path::new("/etc").join("/bin/sh"), PathBuf::from("/bin/sh"));
1.0.0 · Source

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

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

See PathBuf::set_file_name for more details.

§Examples
use std::path::{Path, PathBuf};

let path = Path::new("/tmp/foo.png");
assert_eq!(path.with_file_name("bar"), PathBuf::from("/tmp/bar"));
assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));

let path = Path::new("/tmp");
assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));
1.0.0 · Source

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

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

See PathBuf::set_extension for more details.

§Examples
use std::path::Path;

let path = Path::new("foo.rs");
assert_eq!(path.with_extension("txt"), Path::new("foo.txt"));
assert_eq!(path.with_extension(""), Path::new("foo"));

Handling multiple extensions:

use std::path::Path;

let path = Path::new("foo.tar.gz");
assert_eq!(path.with_extension("xz"), Path::new("foo.tar.xz"));
assert_eq!(path.with_extension("").with_extension("txt"), Path::new("foo.txt"));

Adding an extension where one did not exist:

use std::path::Path;

let path = Path::new("foo");
assert_eq!(path.with_extension("rs"), Path::new("foo.rs"));
Source

pub fn with_added_extension<S>(&self, extension: S) -> PathBuf
where S: AsRef<OsStr>,

🔬This is a nightly-only experimental API. (path_add_extension)

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

See PathBuf::add_extension for more details.

§Examples
#![feature(path_add_extension)]

use std::path::{Path, PathBuf};

let path = Path::new("foo.rs");
assert_eq!(path.with_added_extension("txt"), PathBuf::from("foo.rs.txt"));

let path = Path::new("foo.tar.gz");
assert_eq!(path.with_added_extension(""), PathBuf::from("foo.tar.gz"));
assert_eq!(path.with_added_extension("xz"), PathBuf::from("foo.tar.gz.xz"));
assert_eq!(path.with_added_extension("").with_added_extension("txt"), PathBuf::from("foo.tar.gz.txt"));
1.0.0 · Source

pub fn components(&self) -> Components<'_>

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).

§Examples
use std::path::{Path, Component};
use std::ffi::OsStr;

let mut components = Path::new("/tmp/foo.txt").components();

assert_eq!(components.next(), Some(Component::RootDir));
assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
assert_eq!(components.next(), Some(Component::Normal(OsStr::new("foo.txt"))));
assert_eq!(components.next(), None)
1.0.0 · Source

pub fn iter(&self) -> Iter<'_>

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.

§Examples
use std::path::{self, Path};
use std::ffi::OsStr;

let mut it = Path::new("/tmp/foo.txt").iter();
assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));
assert_eq!(it.next(), Some(OsStr::new("tmp")));
assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
assert_eq!(it.next(), None)
1.0.0 · Source

pub fn display(&self) -> Display<'_>

Returns an object that implements Display for safely printing paths that may contain non-Unicode data. This may perform lossy conversion, depending on the platform. If you would like an implementation which escapes the path please use Debug instead.

§Examples
use std::path::Path;

let path = Path::new("/tmp/foo.rs");

println!("{}", path.display());
1.5.0 · Source

pub fn metadata(&self) -> Result<Metadata, Error>

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.

§Examples
use std::path::Path;

let path = Path::new("/Minas/tirith");
let metadata = path.metadata().expect("metadata call failed");
println!("{:?}", metadata.file_type());

Queries the metadata about a file without following symlinks.

This is an alias to fs::symlink_metadata.

§Examples
use std::path::Path;

let path = Path::new("/Minas/tirith");
let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
println!("{:?}", metadata.file_type());
1.5.0 · Source

pub fn canonicalize(&self) -> Result<PathBuf, Error>

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

This is an alias to fs::canonicalize.

§Examples
use std::path::{Path, PathBuf};

let path = Path::new("/foo/test/../test/bar.rs");
assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));
Source

pub fn normalize_lexically(&self) -> Result<PathBuf, NormalizeError>

🔬This is a nightly-only experimental API. (normalize_lexically)

Normalize a path, including .. without traversing the filesystem.

Returns an error if normalization would leave leading .. components.

This function always resolves .. to the “lexical” parent. That is “a/b/../c” will always resolve to a/c which can change the meaning of the path. In particular, a/c and a/b/../c are distinct on many systems because b may be a symbolic link, so its parent isn’t a.

path::absolute is an alternative that preserves ... Or Path::canonicalize can be used to resolve any .. by querying the filesystem.

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

This is an alias to fs::read_link.

§Examples
use std::path::Path;

let path = Path::new("/laputa/sky_castle.rs");
let path_link = path.read_link().expect("read_link call failed");
1.5.0 · Source

pub fn read_dir(&self) -> Result<ReadDir, Error>

Returns an iterator over the entries within a directory.

The iterator will yield instances of io::Result<fs::DirEntry>. New errors may be encountered after an iterator is initially constructed.

This is an alias to fs::read_dir.

§Examples
use std::path::Path;

let path = Path::new("/laputa");
for entry in path.read_dir().expect("read_dir call failed") {
    if let Ok(entry) = entry {
        println!("{:?}", entry.path());
    }
}
1.5.0 · Source

pub fn exists(&self) -> bool

Returns true if the path points at an existing entity.

Warning: this method may be error-prone, consider using try_exists() instead! It also has a risk of introducing time-of-check to time-of-use (TOCTOU) bugs.

This function will traverse symbolic links to query information about the destination file.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

§Examples
use std::path::Path;
assert!(!Path::new("does_not_exist.txt").exists());
§See Also

This is a convenience function that coerces errors to false. If you want to check errors, call Path::try_exists.

1.63.0 · Source

pub fn try_exists(&self) -> Result<bool, Error>

Returns Ok(true) if 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 Ok(false).

Path::exists() only checks whether or not a path was both found and readable. By contrast, try_exists will return Ok(true) or Ok(false), respectively, if the path was verified to exist or not exist. If its existence can neither be confirmed nor denied, it will propagate an Err(_) instead. This can be the case if e.g. listing permission is denied on one of the parent directories.

Note that while this avoids some pitfalls of the exists() method, it still can not prevent time-of-check to time-of-use (TOCTOU) bugs. You should only use it in scenarios where those bugs are not an issue.

This is an alias for std::fs::exists.

§Examples
use std::path::Path;
assert!(!Path::new("does_not_exist.txt").try_exists().expect("Can't check existence of file does_not_exist.txt"));
assert!(Path::new("/root/secret_file.txt").try_exists().is_err());
1.5.0 · Source

pub fn is_file(&self) -> bool

Returns true if 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.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

§Examples
use std::path::Path;
assert_eq!(Path::new("./is_a_directory/").is_file(), false);
assert_eq!(Path::new("a_file.txt").is_file(), true);
§See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata and handle its Result. Then call fs::Metadata::is_file if it was Ok.

When the goal is simply to read from (or write to) the source, the most reliable way to test the source can be read (or written to) is to open it. Only using is_file can break workflows like diff <( prog_a ) on a Unix-like system for example. See fs::File::open or fs::OpenOptions::open for more information.

1.5.0 · Source

pub fn is_dir(&self) -> bool

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

This function will traverse symbolic links to query information about the destination file.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

§Examples
use std::path::Path;
assert_eq!(Path::new("./is_a_directory/").is_dir(), true);
assert_eq!(Path::new("a_file.txt").is_dir(), false);
§See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata and handle its Result. Then call fs::Metadata::is_dir if it was Ok.

Returns true if the path exists on disk and is pointing at a symbolic link.

This function will not traverse symbolic links. In case of a broken symbolic link this will also return true.

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

§Examples
use std::path::Path;
use std::os::unix::fs::symlink;

let link_path = Path::new("link");
symlink("/origin_does_not_exist/", link_path).unwrap();
assert_eq!(link_path.is_symlink(), true);
assert_eq!(link_path.exists(), false);
§See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::symlink_metadata and handle its Result. Then call fs::Metadata::is_symlink if it was Ok.

Trait Implementations§

Source§

impl AsRef<Path> for TempDir

Source§

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Borrow<Path> for &TempDir

Source§

fn borrow(&self) -> &Path

Immutably borrows from an owned value. Read more
Source§

impl Borrow<Path> for TempDir

Source§

fn borrow(&self) -> &Path

Immutably borrows from an owned value. Read more
Source§

impl Debug for TempDir

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Deref for TempDir

Allows implicit treatment of TempDir as a Path.

Source§

type Target = Path

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl Drop for TempDir

Ensures the file handles are closed before the core reference is freed. If the core reference would be freed while handles are still open, it is possible that the underlying file cannot be deleted.

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.