std::fs::FileType - Rust

Implementations

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

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

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

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

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

`impl Copy for FileType`[src]

`impl Debug for FileType`[src]

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

`impl Eq for FileType`[src]

`impl FileTypeExt for FileType`[src]1.5.0

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

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

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

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

`impl FileTypeExt for FileType`[src]

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

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

`impl Hash for FileType`[src]

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

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

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

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

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

`impl StructuralEq for FileType`[src]

`impl StructuralPartialEq for FileType`[src]

Blanket Implementations

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

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

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

fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W

[src]

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

fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W

[src]

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

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

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

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

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

`type Owned = T`

The resulting type after obtaining ownership.

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

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

`impl<T, U> TryFrom 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>::Error>`[src]

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

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

© 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

Struct std::fs::FileType

Implementations

impl FileType[src]

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

Examples

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

Examples

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

Examples

Trait Implementations

impl Clone for FileType[src]

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

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

impl Copy for FileType[src]

impl Debug for FileType[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result[src]

impl Eq for FileType[src]

impl FileTypeExt for FileType[src]1.5.0

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

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

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

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

impl FileTypeExt for FileType[src]

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

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

impl Hash for FileType[src]

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

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

impl PartialEq<FileType> for FileType[src]

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

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

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]

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

Notable traits for &'_ mut F

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

Notable traits for &'_ mut F

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

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

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

fn into(self) -> U[src]

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

type Owned = T

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

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

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

type Error = Infallible

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

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

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

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

`impl FileType`[src]

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

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

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

`impl Clone for FileType`[src]

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

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

`impl Copy for FileType`[src]

`impl Debug for FileType`[src]

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

`impl Eq for FileType`[src]

`impl FileTypeExt for FileType`[src]1.5.0

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

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

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

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

`impl FileTypeExt for FileType`[src]

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

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

`impl Hash for FileType`[src]

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

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

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

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

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

`impl StructuralEq for FileType`[src]

`impl StructuralPartialEq for FileType`[src]

`impl RefUnwindSafe for FileType`

`impl Send for FileType`

`impl Sync for FileType`

`impl Unpin for FileType`

`impl UnwindSafe for FileType`

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

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

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

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

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

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

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

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

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

`type Owned = T`

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

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

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

`type Error = Infallible`

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

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

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

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