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.

## Methods

###

`impl FileType`

[src]

####

`pub fn is_dir(&self) -> bool`

[src]

Test 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]

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

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

Test 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 Copy for FileType`

[src]

###

`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 PartialEq 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 Eq for FileType`

[src]

###

`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 Debug for FileType`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl FileTypeExt for FileType`

1.5.0
[src]

####

`fn is_block_device(&self) -> bool`

[src]

This is supported on Unix only.

Returns whether this file type is a block device. Read more

####

`fn is_char_device(&self) -> bool`

[src]

This is supported on Unix only.

Returns whether this file type is a char device. Read more

####

`fn is_fifo(&self) -> bool`

[src]

This is supported on Unix only.

Returns whether this file type is a fifo. Read more

####

`fn is_socket(&self) -> bool`

[src]

This is supported on Unix only.

Returns whether 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 whether 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 whether this file type is a symbolic link that is also a file.

## Auto Trait Implementations

###

`impl Send for FileType`

###

`impl Sync for FileType`

## Blanket Implementations

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

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

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

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

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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

###

`impl<T> ToOwned for T where T: Clone,`

[src]

#### `type Owned = T`

####

`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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)