Struct std::fs::FileType
pub struct FileType(_);
A structure representing a type of file with accessors for each file type. It is returned by Metadata::file_type method.
Implementations
impl FileType
pub fn is_dir(&self) -> bool
Tests whether this file type represents a directory. The result is mutually exclusive to the results of is_file and is_symlink; only zero or one of these tests may pass.
Examples
fn main() -> std::io::Result<()> {
use std::fs;
let metadata = fs::metadata("foo.txt")?;
let file_type = metadata.file_type();
assert_eq!(file_type.is_dir(), false);
Ok(())
}pub fn is_file(&self) -> bool
Tests whether this file type represents a regular file. The result is mutually exclusive to the results of is_dir and is_symlink; only zero or one of these tests may pass.
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 File::open or OpenOptions::open for more information.
Examples
fn main() -> std::io::Result<()> {
use std::fs;
let metadata = fs::metadata("foo.txt")?;
let file_type = metadata.file_type();
assert_eq!(file_type.is_file(), true);
Ok(())
}pub fn is_symlink(&self) -> bool
Tests whether this file type represents a symbolic link. The result is mutually exclusive to the results of is_dir and is_file; only zero or one of these tests may pass.
The underlying Metadata struct needs to be retrieved with the fs::symlink_metadata function and not the fs::metadata function. The fs::metadata function follows symbolic links, so is_symlink would always return false for the target file.
Examples
use std::fs;
fn main() -> std::io::Result<()> {
let metadata = fs::symlink_metadata("foo.txt")?;
let file_type = metadata.file_type();
assert_eq!(file_type.is_symlink(), false);
Ok(())
}Trait Implementations
impl Clone for FileType
fn clone(&self) -> FileType
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
impl Debug for FileType
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
fn is_block_device(&self) -> bool
Returns true if this file type is a block device. Read more
fn is_char_device(&self) -> bool
Returns true if this file type is a char device. Read more
fn is_fifo(&self) -> bool
Returns true if this file type is a fifo. Read more
fn is_socket(&self) -> bool
Returns true if this file type is a socket. Read more
fn is_block_device(&self) -> bool
Returns true if this file type is a block device.
fn is_character_device(&self) -> bool
Returns true if this file type is a character device.
fn is_socket_dgram(&self) -> bool
Returns true if this file type is a socket datagram.
fn is_socket_stream(&self) -> bool
Returns true if this file type is a socket stream.
fn is_symlink_dir(&self) -> bool
windows_file_type_ext)Returns true if this file type is a symbolic link that is also a directory.
fn is_symlink_file(&self) -> bool
windows_file_type_ext)Returns true if this file type is a symbolic link that is also a file.
impl Hash for FileType
fn hash<__H: Hasher>(&self, state: &mut __H)
impl PartialEq<FileType> for FileType
fn eq(&self, other: &FileType) -> bool
This method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, other: &FileType) -> bool
This method tests for !=.
impl Copy for FileType
impl Eq for FileType
impl StructuralEq for FileType
impl StructuralPartialEq for FileType
Auto Trait Implementations
impl RefUnwindSafe for FileType
impl Send for FileType
impl Sync for FileType
impl Unpin for FileType
impl UnwindSafe for FileType
Blanket Implementations
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into #41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/fs/struct.FileType.html