about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJulius Liu <juliusl@microsoft.com>2024-09-09 13:56:41 -0700
committerJulius Liu <juliusl@microsoft.com>2024-09-09 13:56:41 -0700
commita0a89e55387dc4291442e5fc401bd1e35b94fbe8 (patch)
tree7a28b68705dbac2687cc443905798f033648cd4d
parent2f1e1be6ffbf39e3a7b219343e4be38cab599cf4 (diff)
downloadrust-a0a89e55387dc4291442e5fc401bd1e35b94fbe8.tar.gz
rust-a0a89e55387dc4291442e5fc401bd1e35b94fbe8.zip
chore: removing supporting links in favor of existing doc-comment style
-rw-r--r--library/std/src/os/windows/fs.rs19
1 files changed, 6 insertions, 13 deletions
diff --git a/library/std/src/os/windows/fs.rs b/library/std/src/os/windows/fs.rs
index 285d9c3fc78..d03f9e0e330 100644
--- a/library/std/src/os/windows/fs.rs
+++ b/library/std/src/os/windows/fs.rs
@@ -472,21 +472,14 @@ pub trait MetadataExt {
     #[unstable(feature = "windows_by_handle", issue = "63010")]
     fn file_index(&self) -> Option<u64>;
 
-    /// Returns the value of the `ChangeTime{Low,High}` field from the
-    /// [`FILE_BASIC_INFO`] struct associated with the current file handle.
-    /// [`ChangeTime`] is the last time file metadata was changed, such as
-    /// renames, attributes, etc.
+    /// Returns the value of the `ChangeTime{Low,High}` fields of this metadata.
     ///
-    /// This will return `None` if `Metadata` was populated without access to
-    /// [`FILE_BASIC_INFO`]. For example, the result of `std::fs::read_dir`
-    /// will be derived from [`WIN32_FIND_DATA`] which does not have access to
-    /// `ChangeTime`.
+    /// `ChangeTime` is the last time file metadata was changed, such as
+    /// renames, attributes, etc.
     ///
-    /// [`FILE_BASIC_INFO`]: https://learn.microsoft.com/windows/win32/api/winbase/ns-winbase-file_basic_info
-    /// [`WIN32_FIND_DATA`]: https://learn.microsoft.com/windows/win32/api/minwinbase/ns-minwinbase-win32_find_dataw
-    /// [`FindFirstFile`]: https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-findfirstfilea
-    /// [`FindNextFile`]: https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-findnextfilea
-    /// [`ChangeTime`]: https://devblogs.microsoft.com/oldnewthing/20100709-00/?p=13463.
+    /// This will return `None` if `Metadata` instance was created from a call to
+    /// `DirEntry::metadata` or if the `target_vendor` is outside the current platform
+    /// support for this api.
     #[unstable(feature = "windows_change_time", issue = "121478")]
     fn change_time(&self) -> Option<u64>;
 }