Skip to content

Commit

Permalink
Rollup merge of rust-lang#130168 - juliusl:pr/fix-win-fs-change-time-…
Browse files Browse the repository at this point in the history
…links, r=ChrisDenton

maint: update docs for change_time ext and doc links

maint: update docs for change_time ext and doc links

Related: rust-lang#121478
r? tgross35
  • Loading branch information
workingjubilee authored Sep 11, 2024
2 parents d86d1ad + 5527076 commit 0ad8638
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions library/std/src/os/windows/fs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ impl OpenOptionsExt for OpenOptions {
/// of the [`BY_HANDLE_FILE_INFORMATION`] structure.
///
/// [`BY_HANDLE_FILE_INFORMATION`]:
/// https://docs.microsoft.com/en-us/windows/win32/api/fileapi/ns-fileapi-by_handle_file_information
/// https://docs.microsoft.com/windows/win32/api/fileapi/ns-fileapi-by_handle_file_information
#[stable(feature = "metadata_ext", since = "1.1.0")]
pub trait MetadataExt {
/// Returns the value of the `dwFileAttributes` field of this metadata.
Expand All @@ -322,7 +322,7 @@ pub trait MetadataExt {
/// ```
///
/// [File Attribute Constants]:
/// https://docs.microsoft.com/en-us/windows/win32/fileio/file-attribute-constants
/// https://docs.microsoft.com/windows/win32/fileio/file-attribute-constants
#[stable(feature = "metadata_ext", since = "1.1.0")]
fn file_attributes(&self) -> u32;

Expand Down Expand Up @@ -351,7 +351,7 @@ pub trait MetadataExt {
/// }
/// ```
///
/// [`FILETIME`]: https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime
/// [`FILETIME`]: https://docs.microsoft.com/windows/win32/api/minwinbase/ns-minwinbase-filetime
#[stable(feature = "metadata_ext", since = "1.1.0")]
fn creation_time(&self) -> u64;

Expand Down Expand Up @@ -386,7 +386,7 @@ pub trait MetadataExt {
/// }
/// ```
///
/// [`FILETIME`]: https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime
/// [`FILETIME`]: https://docs.microsoft.com/windows/win32/api/minwinbase/ns-minwinbase-filetime
#[stable(feature = "metadata_ext", since = "1.1.0")]
fn last_access_time(&self) -> u64;

Expand Down Expand Up @@ -419,11 +419,11 @@ pub trait MetadataExt {
/// }
/// ```
///
/// [`FILETIME`]: https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime
/// [`FILETIME`]: https://docs.microsoft.com/windows/win32/api/minwinbase/ns-minwinbase-filetime
#[stable(feature = "metadata_ext", since = "1.1.0")]
fn last_write_time(&self) -> u64;

/// Returns the value of the `nFileSize{High,Low}` fields of this
/// Returns the value of the `nFileSize` fields of this
/// metadata.
///
/// The returned value does not have meaning for directories.
Expand Down Expand Up @@ -462,7 +462,7 @@ pub trait MetadataExt {
#[unstable(feature = "windows_by_handle", issue = "63010")]
fn number_of_links(&self) -> Option<u32>;

/// Returns the value of the `nFileIndex{Low,High}` fields of this
/// Returns the value of the `nFileIndex` fields of this
/// metadata.
///
/// This will return `None` if the `Metadata` instance was created from a
Expand All @@ -471,10 +471,14 @@ pub trait MetadataExt {
#[unstable(feature = "windows_by_handle", issue = "63010")]
fn file_index(&self) -> Option<u64>;

/// Returns the change time, which is the last time file metadata was changed, such as
/// renames, attributes, etc
/// Returns the value of the `ChangeTime` fields of this metadata.
///
/// This will return `None` if the `Metadata` instance was not created using the `FILE_BASIC_INFO` type.
/// `ChangeTime` is the last time file metadata was changed, such as
/// renames, attributes, etc.
///
/// 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>;
}
Expand Down

0 comments on commit 0ad8638

Please sign in to comment.