std::os::unix::fs::FileTypeExt - Rust
Description: API documentation for the Rust `FileTypeExt` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, FileTypeExt

# 1.5.0[−][src]Trait std::os::unix::fs::FileTypeExt

    pub trait FileTypeExt {
        fn is_block_device(&self) -> bool;
        fn is_char_device(&self) -> bool;
        fn is_fifo(&self) -> bool;
        fn is_socket(&self) -> bool;
    }

This is supported on Unix only.

Unix-specific extensions for `FileType`.

Adds support for special Unix file types such as block/character devices, pipes, and sockets.

## Required methods

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

This is supported on Unix only.

Returns whether this file type is a block device.

# Examples

    use std::fs;
    use std::os::unix::fs::FileTypeExt;
    use std::io;

    fn main() -> io::Result<()> {
        let meta = fs::metadata("block_device_file")?;
        let file_type = meta.file_type();
        assert!(file_type.is_block_device());
        Ok(())
    }Run

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

This is supported on Unix only.

Returns whether this file type is a char device.

# Examples

    use std::fs;
    use std::os::unix::fs::FileTypeExt;
    use std::io;

    fn main() -> io::Result<()> {
        let meta = fs::metadata("char_device_file")?;
        let file_type = meta.file_type();
        assert!(file_type.is_char_device());
        Ok(())
    }Run

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

This is supported on Unix only.

Returns whether this file type is a fifo.

# Examples

    use std::fs;
    use std::os::unix::fs::FileTypeExt;
    use std::io;

    fn main() -> io::Result<()> {
        let meta = fs::metadata("fifo_file")?;
        let file_type = meta.file_type();
        assert!(file_type.is_fifo());
        Ok(())
    }Run

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

This is supported on Unix only.

Returns whether this file type is a socket.

# Examples

    use std::fs;
    use std::os::unix::fs::FileTypeExt;
    use std::io;

    fn main() -> io::Result<()> {
        let meta = fs::metadata("unix.socket")?;
        let file_type = meta.file_type();
        assert!(file_type.is_socket());
        Ok(())
    }Run

Loading content...

## Implementors

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

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

This is supported on Unix only.

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

This is supported on Unix only.

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

This is supported on Unix only.

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

This is supported on Unix only.
Loading content...

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