std::fs::FileType - Rust
Description: API documentation for the Rust `FileType` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, FileType

# 1.1.0[−][src]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`[src]

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

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(())
    }

Run

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

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(())
    }

Run

#### `pub fn is_symlink(&self) -> bool`[src]

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(())
    }

Run

## Trait Implementations

### `impl Clone for FileType`[src]

#### `fn clone(&self) -> FileType`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

### `impl Copy for FileType`[src]

### `impl Debug for FileType`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl Eq for FileType`[src]

### `impl FileTypeExt for FileType` 1.5.0[src]

#### `fn is_block_device(&self) -> bool`[src]

This is supported on Unix only.

Returns `true` if this file type is a block device. Read more

#### `fn is_char_device(&self) -> bool`[src]

This is supported on Unix only.

Returns `true` if this file type is a char device. Read more

#### `fn is_fifo(&self) -> bool`[src]

This is supported on Unix only.

Returns `true` if this file type is a fifo. Read more

#### `fn is_socket(&self) -> bool`[src]

This is supported on Unix only.

Returns `true` if this file type is a socket. Read more

### `impl FileTypeExt for FileType`[src]

#### `fn is_symlink_dir(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`windows_file_type_ext`)
This is supported on Windows only.

Returns `true` if this file type is a symbolic link that is also a directory.

#### `fn is_symlink_file(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`windows_file_type_ext`)
This is supported on Windows only.

Returns `true` if this file type is a symbolic link that is also a file.

### `impl Hash for FileType`[src]

#### `fn hash<__H: Hasher>(&self, state: &mut __H)`[src]

Feeds this value into the given [`Hasher`]. Read more

#### `fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0[src]

Feeds a slice of this type into the given [`Hasher`]. Read more

### `impl PartialEq<FileType> for FileType`[src]

#### `fn eq(&self, other: &FileType) -> bool`[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &FileType) -> bool`[src]

This method tests for `!=`.

### `impl StructuralEq for FileType`[src]

### `impl StructuralPartialEq for FileType`[src]

## 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> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

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

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

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

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `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]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `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]

Performs the conversion.