From 50da1eb1cddb6a6735d3601751f300d0773be65e Mon Sep 17 00:00:00 2001 From: Chris Denton Date: Fri, 27 Aug 2021 14:25:29 +0100 Subject: [PATCH] Document `std::env::current_exe` rename behaviour It might not be obvious that the "path of the current running executable" may (or may not) mean "at the time it was loaded". --- library/std/src/env.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/library/std/src/env.rs b/library/std/src/env.rs index a7465200955..e343073d215 100644 --- a/library/std/src/env.rs +++ b/library/std/src/env.rs @@ -616,6 +616,9 @@ pub fn temp_dir() -> PathBuf { /// return the path of the symbolic link and other platforms will return the /// path of the symbolic link’s target. /// +/// If the executable is renamed while it is running, platforms may return the +/// path at the time it was loaded instead of the new path. +/// /// # Errors /// /// Acquiring the path of the current executable is a platform-specific operation -- 2.44.0