itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-28 11:20:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add wrappers around std::fs::metadata

Browse Source 
This adds wrappers around std::fs::metadata and
std::fs::symlink_metadata which provide better error messages indicating
the path that caused the error.
This commit is contained in:
Eric Huss 2023-09-06 19:33:01 -07:00
parent 016fe194a3
commit 62d86470d1
1 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
crates/cargo-util/src/paths.rs
View File

@ -4,7 +4,7 @@ use anyhow::{Context, Result};
use filetime::FileTime; use filetime::FileTime;
use std::env; use std::env;
use std::ffi::{OsStr, OsString}; use std::ffi::{OsStr, OsString};
use std::fs::{self, File, OpenOptions}; use std::fs::{self, File, Metadata, OpenOptions};
use std::io; use std::io;
use std::io::prelude::*; use std::io::prelude::*;
use std::iter; use std::iter;
@ -136,6 +136,24 @@ pub fn resolve_executable(exec: &Path) -> Result<PathBuf> {
} }
} }
/// Returns metadata for a file (follows symlinks).
///
/// Equivalent to [`std::fs::metadata`] with better error messages.
pub fn metadata<P: AsRef<Path>>(path: P) -> Result<Metadata> {
let path = path.as_ref();
std::fs::metadata(path)
.with_context(|| format!("failed to load metadata for path `{}`", path.display()))
}
/// Returns metadata for a file without following symlinks.
///
/// Equivalent to [`std::fs::metadata`] with better error messages.
pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> Result<Metadata> {
let path = path.as_ref();
std::fs::symlink_metadata(path)
.with_context(|| format!("failed to load metadata for path `{}`", path.display()))
}
/// Reads a file to a string. /// Reads a file to a string.
/// ///
/// Equivalent to [`std::fs::read_to_string`] with better error messages. /// Equivalent to [`std::fs::read_to_string`] with better error messages.
@ -216,16 +234,14 @@ pub fn open<P: AsRef<Path>>(path: P) -> Result<File> {
/// Returns the last modification time of a file. /// Returns the last modification time of a file.
pub fn mtime(path: &Path) -> Result<FileTime> { pub fn mtime(path: &Path) -> Result<FileTime> {
let meta = let meta = metadata(path)?;
fs::metadata(path).with_context(|| format!("failed to stat `{}`", path.display()))?;
Ok(FileTime::from_last_modification_time(&meta)) Ok(FileTime::from_last_modification_time(&meta))
} }
/// Returns the maximum mtime of the given path, recursing into /// Returns the maximum mtime of the given path, recursing into
/// subdirectories, and following symlinks. /// subdirectories, and following symlinks.
pub fn mtime_recursive(path: &Path) -> Result<FileTime> { pub fn mtime_recursive(path: &Path) -> Result<FileTime> {
let meta = let meta = metadata(path)?;
fs::metadata(path).with_context(|| format!("failed to stat `{}`", path.display()))?;
if !meta.is_dir() { if !meta.is_dir() {
return Ok(FileTime::from_last_modification_time(&meta)); return Ok(FileTime::from_last_modification_time(&meta));
} }
@ -432,10 +448,7 @@ pub fn remove_dir_all<P: AsRef<Path>>(p: P) -> Result<()> {
} }
fn _remove_dir_all(p: &Path) -> Result<()> { fn _remove_dir_all(p: &Path) -> Result<()> {
if p.symlink_metadata() if symlink_metadata(p)?.is_symlink() {
.with_context(|| format!("could not get metadata for `{}` to remove", p.display()))?
.is_symlink()
{
return remove_file(p); return remove_file(p);
} }
let entries = p let entries = p