1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
#![warn(missing_docs)]
//! [![Crates.io](https://img.shields.io/crates/v/file_type_enum.svg)](https://crates.io/crates/file_type_enum)
//! [![Docs.rs](https://docs.rs/file_type_enum/badge.svg)](https://docs.rs/file_type_enum)
//! [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/marcospb19/file_type_enum/blob/main/LICENSE)
//!
//! An enum with a variant for each file type.
//!
//! ```rust
//! pub enum FileType {
//! Regular,
//! Directory,
//! Symlink,
//! BlockDevice, // unix only
//! CharDevice, // unix only
//! Fifo, // unix only
//! Socket, // unix only
//! }
//! ```
//!
//! If you don't need an enum, check these methods from `std` instead:
//!
//! - [`Path::is_file`].
//! - [`Path::is_dir`].
//! - [`Path::is_symlink`].
//!
//! # Example
//!
//! ```
//! use file_type_enum::FileType;
//! use std::io;
//!
//! fn main() -> io::Result<()> {
//! let file_type = FileType::from_path("/tmp")?;
//!
//! println!("There's a {} at /tmp", file_type);
//! // Out: "There's a directory at /tmp"
//!
//! Ok(())
//! }
//! ```
//!
//! Note that the [`FileType::from_path`] follows symlinks and [`FileType::from_symlink_path`] does not.
//!
//! # Conversions
//!
//! - From [`AsRef<Path>`], [`fs::Metadata`] and [std's `FileType`].
//! - From and into [`libc::mode_t`] (via the feature `"mode-t-conversion"`).
//!
//! # Contributing
//!
//! Issues and PRs are welcome.
//!
//! [`AsRef<Path>`]: std::path::Path
//! [`fs::Metadata`]: std::fs::Metadata
//! [std's `FileType`]: std::fs::FileType
#[cfg(feature = "mode-t-conversion")]
mod mode_t_conversion_feature;
#[cfg(unix)]
use std::os::unix::fs::FileTypeExt;
use std::{fmt, fs, io, path::Path};
#[cfg(feature = "mode-t-conversion")]
pub use mode_t_conversion_feature::*;
/// An enum with a variant for each file type.
///
/// ```
/// # use file_type_enum::FileType;
/// # let file_type = FileType::from_path("src/").unwrap();
/// match file_type {
/// FileType::Regular => {},
/// FileType::Directory => {},
/// FileType::Symlink => {},
/// FileType::BlockDevice => {}, // unix only
/// FileType::CharDevice => {}, // unix only
/// FileType::Fifo => {}, // unix only
/// FileType::Socket => {}, // unix only
/// }
/// ```
#[rustfmt::skip]
#[derive(Debug, Eq, PartialEq, Hash, Clone, Copy, Ord, PartialOrd)]
pub enum FileType {
/// A regular file (e.g. '.txt', '.rs', '.zip').
Regular,
/// A directory, folder of files.
Directory,
/// A symbolic link, points to another path.
Symlink,
/// Unix block device.
#[cfg(unix)] BlockDevice,
/// Unix char device.
#[cfg(unix)] CharDevice,
/// Unix FIFO.
#[cfg(unix)] Fifo,
/// Unix socket.
#[cfg(unix)] Socket,
}
impl FileType {
/// Reads a `FileType` from a path.
///
/// This function follows symlinks, so it can never return a `FileType::Symlink`.
///
/// # Example
///
/// ```rust
/// use file_type_enum::FileType;
/// use std::io;
///
/// fn main() -> io::Result<()> {
/// let is_everything_alright = FileType::from_path("/dev/tty")?.is_char_device();
/// Ok(())
/// }
/// ```
///
/// # Errors
///
/// - Path does not exist, or
/// - Current user lacks permissions to read `fs::Metadata` of `path`.
pub fn from_path(path: impl AsRef<Path>) -> io::Result<Self> {
let fs_file_type = fs::metadata(path.as_ref())?.file_type();
let result = FileType::from(fs_file_type);
Ok(result)
}
/// Reads a `FileType` from a path, considers symlinks.
///
/// This function does not follow symlinks, so the result can be the variant `FileType::Symlink` too, unlike [`FileType::from_path`].
///
/// # Example
///
/// ```rust
/// use file_type_enum::FileType;
///
/// let path = "/dev/stdout";
/// let file_type = FileType::from_symlink_path(path).unwrap();
///
/// println!("There's a {file_type} at {path}");
/// // Out: "There's a symlink at /dev/stdout"
/// ```
///
/// # Errors
///
/// - Path does not exist, or
/// - Current user lacks permissions to read `fs::Metadata` of `path`.
pub fn from_symlink_path(path: impl AsRef<Path>) -> io::Result<Self> {
let fs_file_type = fs::symlink_metadata(path.as_ref())?.file_type();
let result = FileType::from(fs_file_type);
Ok(result)
}
/// Returns true if is a [`FileType::Regular`].
pub fn is_regular(&self) -> bool {
matches!(self, FileType::Regular)
}
/// Returns true if is a [`FileType::Directory`].
pub fn is_directory(&self) -> bool {
matches!(self, FileType::Directory)
}
/// Returns true if is a [`FileType::Symlink`].
pub fn is_symlink(&self) -> bool {
matches!(self, FileType::Symlink)
}
/// Returns true if is a [`FileType::BlockDevice`].
#[cfg(unix)]
pub fn is_block_device(&self) -> bool {
matches!(self, FileType::BlockDevice)
}
/// Returns true if is a [`FileType::CharDevice`].
#[cfg(unix)]
pub fn is_char_device(&self) -> bool {
matches!(self, FileType::CharDevice)
}
/// Returns true if is a [`FileType::Fifo`].
#[cfg(unix)]
pub fn is_fifo(&self) -> bool {
matches!(self, FileType::Fifo)
}
/// Returns true if is a [`FileType::Socket`].
#[cfg(unix)]
pub fn is_socket(&self) -> bool {
matches!(self, FileType::Socket)
}
}
impl From<fs::FileType> for FileType {
fn from(ft: fs::FileType) -> Self {
// Check each type
#[cfg(unix)]
let result = {
if ft.is_file() {
FileType::Regular
} else if ft.is_dir() {
FileType::Directory
} else if ft.is_symlink() {
FileType::Symlink
} else if ft.is_block_device() {
FileType::BlockDevice
} else if ft.is_char_device() {
FileType::CharDevice
} else if ft.is_fifo() {
FileType::Fifo
} else if ft.is_socket() {
FileType::Socket
} else {
unreachable!("file_type_enum: unexpected file type: {:?}.", ft)
}
};
#[cfg(not(unix))]
let result = {
if ft.is_file() {
FileType::Regular
} else if ft.is_dir() {
FileType::Directory
} else if ft.is_symlink() {
FileType::Symlink
} else {
unreachable!("file_type_enum: unexpected file type: {:?}.", ft)
}
};
result
}
}
impl From<fs::Metadata> for FileType {
fn from(metadata: fs::Metadata) -> Self {
metadata.file_type().into()
}
}
impl fmt::Display for FileType {
#[rustfmt::skip]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
FileType::Regular => write!(f, "regular file"),
FileType::Directory => write!(f, "directory"),
FileType::Symlink => write!(f, "symbolic link"),
#[cfg(unix)] FileType::BlockDevice => write!(f, "block device"),
#[cfg(unix)] FileType::CharDevice => write!(f, "char device"),
#[cfg(unix)] FileType::Fifo => write!(f, "FIFO"),
#[cfg(unix)] FileType::Socket => write!(f, "socket"),
}
}
}
#[cfg(test)]
mod tests {
use super::FileType;
#[test]
fn test_with_this_repository_structured() {
let this_file = FileType::from_path("src/lib.rs").unwrap();
assert!(this_file.is_regular());
}
}