actions/cargo-binstall
1
0
Fork 0
mirror of https://github.com/cargo-bins/cargo-binstall.git synced 2025-06-15 15:16:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add optional logging to FileLock::drop

Browse source 
Signed-off-by: Jiahao XU <30436523+NobodyXu@users.noreply.github.com>
This commit is contained in:
Jiahao XU 2025-02-22 22:10:50 +11:00 • committed by GitHub
parent 24c36a51e1
commit fb56382274
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 26 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

32
crates/fs-lock/src/lib.rs
View file

@ -12,7 +12,7 @@ use fs4::fs_std::FileExt;
/// A locked file. /// A locked file.
#[derive(Debug)] #[derive(Debug)]
pub struct FileLock(File); pub struct FileLock(File, Option<Box<Path>>);
impl FileLock { impl FileLock {
/// Take an exclusive lock on a [`File`]. /// Take an exclusive lock on a [`File`].
@ -21,7 +21,7 @@ impl FileLock {
pub fn new_exclusive(file: File) -> io::Result<Self> { pub fn new_exclusive(file: File) -> io::Result<Self> {
FileExt::lock_exclusive(&file)?; FileExt::lock_exclusive(&file)?;
Ok(Self(file)) Ok(Self(file, None))
} }
/// Try to take an exclusive lock on a [`File`]. /// Try to take an exclusive lock on a [`File`].
@ -33,7 +33,7 @@ impl FileLock {
/// Note that this operation is blocking, and should not be called in async contexts. /// Note that this operation is blocking, and should not be called in async contexts.
pub fn new_try_exclusive(file: File) -> Result<Self, (File, Option<io::Error>)> { pub fn new_try_exclusive(file: File) -> Result<Self, (File, Option<io::Error>)> {
match FileExt::try_lock_exclusive(&file) { match FileExt::try_lock_exclusive(&file) {
Ok(()) => Ok(Self(file)), Ok(()) => Ok(Self(file, None)),
Err(e) if e.raw_os_error() == fs4::lock_contended_error().raw_os_error() => { Err(e) if e.raw_os_error() == fs4::lock_contended_error().raw_os_error() => {
Err((file, None)) Err((file, None))
} }
@ -47,7 +47,7 @@ impl FileLock {
pub fn new_shared(file: File) -> io::Result<Self> { pub fn new_shared(file: File) -> io::Result<Self> {
FileExt::lock_shared(&file)?; FileExt::lock_shared(&file)?;
Ok(Self(file)) Ok(Self(file, None))
} }
/// Try to take a shared lock on a [`File`]. /// Try to take a shared lock on a [`File`].
@ -59,7 +59,7 @@ impl FileLock {
/// Note that this operation is blocking, and should not be called in async contexts. /// Note that this operation is blocking, and should not be called in async contexts.
pub fn new_try_shared(file: File) -> Result<Self, (File, Option<io::Error>)> { pub fn new_try_shared(file: File) -> Result<Self, (File, Option<io::Error>)> {
match FileExt::try_lock_shared(&file) { match FileExt::try_lock_shared(&file) {
Ok(()) => Ok(Self(file)), Ok(()) => Ok(Self(file, None)),
Err(e) if e.raw_os_error() == fs4::lock_contended_error().raw_os_error() => { Err(e) if e.raw_os_error() == fs4::lock_contended_error().raw_os_error() => {
Err((file, None)) Err((file, None))
} }
@ -70,7 +70,27 @@ impl FileLock {
impl Drop for FileLock { impl Drop for FileLock {
fn drop(&mut self) { fn drop(&mut self) {
let _ = FileExt::unlock(&self.0); let _res = FileExt::unlock(&self.0);
#[cfg(feature = "tracing")]
if let Err(err) = _res {
use std::fmt;
struct OptionalPath<'a>(Option<&'a Path>);
impl fmt::Display for OptionalPath<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if let Some(path) = self.0 {
fmt::Display::fmt(&path.display(), f)
} else {
Ok(())
}
}
}
tracing::warn!(
"Failed to unlock file{}: {err}",
OptionalPath(self.1.as_deref()),
);
}
} }
} }