File tree Expand file tree Collapse file tree 1 file changed +10
-4
lines changed Expand file tree Collapse file tree 1 file changed +10
-4
lines changed Original file line number Diff line number Diff line change @@ -975,10 +975,16 @@ impl FileType {
975
975
976
976
/// Test whether this file type represents a symbolic link.
977
977
///
978
- /// The Metadata struct needs to be retreived with
979
- /// fs::symlink_metadata() not fs::metadata(). metadata()
980
- /// always follows symbolic links, so is_symlink will
981
- /// always return false for the underlying file.
978
+ /// The underlying [`Metadata`] struct needs to be retrieved
979
+ /// with the [`fs::symlink_metadata`] function and not the
980
+ /// [`fs::metadata`] function. The [`fs::metadata`] function
981
+ /// follows symbolic links, so [`is_symlink`] would always
982
+ /// return false for the target file.
983
+ ///
984
+ /// [`Metadata`]: struct.Metadata.html
985
+ /// [`fs::metadata`]: fn.metadata.html
986
+ /// [`fs::symlink_metadata`]: fn.symlink_metadata.html
987
+ /// [`is_symlink`]: struct.FileType.html#method.is_symlink
982
988
///
983
989
/// # Examples
984
990
///
You can’t perform that action at this time.
0 commit comments