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

# Struct std::fs::FileType 1.1.0 [−] [src]

    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]

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

Test whether this file type represents a directory.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;
    let file_type = metadata.file_type();

    assert_eq!(file_type.is_dir(), false);Run

#### `fn is_file(&self) -> bool`

Test whether this file type represents a regular file.

# Examples

    use std::fs;

    let metadata = fs::metadata("foo.txt")?;
    let file_type = metadata.file_type();

    assert_eq!(file_type.is_file(), true);Run

#### `fn is_symlink(&self) -> bool`

Test whether this file type represents a symbolic link.

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;

    let metadata = fs::symlink_metadata("foo.txt")?;
    let file_type = metadata.file_type();

    assert_eq!(file_type.is_symlink(), false);Run

## Trait Implementations

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

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

#### `fn clone(&self) -> FileType`

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

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

#### `fn eq(&self, __arg_0: &FileType) -> bool`

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

#### `fn ne(&self, __arg_0: &FileType) -> bool`

This method tests for `!=`.

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

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

#### `fn hash<__H: Hasher>(&self, __arg_0: &mut __H)`

Feeds this value into the state given, updating the hasher as necessary.

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

Feeds a slice of this type into the state provided.

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

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

Formats the value using the given formatter.

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

#### `fn is_block_device(&self) -> bool`

Returns whether this file type is a block device.

#### `fn is_char_device(&self) -> bool`

Returns whether this file type is a char device.

#### `fn is_fifo(&self) -> bool`

Returns whether this file type is a fifo.

#### `fn is_socket(&self) -> bool`

Returns whether this file type is a socket.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)