Skip to content

Commit 136504a

Browse files
Rollup merge of rust-lang#130168 - juliusl:pr/fix-win-fs-change-time-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
2 parents e9cd33c + 3e2ea2b commit 136504a

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

std/src/os/windows/fs.rs

+14-10
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ impl OpenOptionsExt for OpenOptions {
298298
/// of the [`BY_HANDLE_FILE_INFORMATION`] structure.
299299
///
300300
/// [`BY_HANDLE_FILE_INFORMATION`]:
301-
/// https://docs.microsoft.com/en-us/windows/win32/api/fileapi/ns-fileapi-by_handle_file_information
301+
/// https://docs.microsoft.com/windows/win32/api/fileapi/ns-fileapi-by_handle_file_information
302302
#[stable(feature = "metadata_ext", since = "1.1.0")]
303303
pub trait MetadataExt {
304304
/// Returns the value of the `dwFileAttributes` field of this metadata.
@@ -322,7 +322,7 @@ pub trait MetadataExt {
322322
/// ```
323323
///
324324
/// [File Attribute Constants]:
325-
/// https://docs.microsoft.com/en-us/windows/win32/fileio/file-attribute-constants
325+
/// https://docs.microsoft.com/windows/win32/fileio/file-attribute-constants
326326
#[stable(feature = "metadata_ext", since = "1.1.0")]
327327
fn file_attributes(&self) -> u32;
328328

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

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

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

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

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

474-
/// Returns the change time, which is the last time file metadata was changed, such as
475-
/// renames, attributes, etc
474+
/// Returns the value of the `ChangeTime` fields of this metadata.
476475
///
477-
/// This will return `None` if the `Metadata` instance was not created using the `FILE_BASIC_INFO` type.
476+
/// `ChangeTime` is the last time file metadata was changed, such as
477+
/// renames, attributes, etc.
478+
///
479+
/// This will return `None` if `Metadata` instance was created from a call to
480+
/// `DirEntry::metadata` or if the `target_vendor` is outside the current platform
481+
/// support for this api.
478482
#[unstable(feature = "windows_change_time", issue = "121478")]
479483
fn change_time(&self) -> Option<u64>;
480484
}

0 commit comments

Comments
 (0)