Skip to content

Commit

Permalink
Review fixes + doc-features
Browse files Browse the repository at this point in the history
  • Loading branch information
maxwase committed May 27, 2021
1 parent 2d88c52 commit a0958df
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
5 changes: 3 additions & 2 deletions library/std/src/fs.rs
Expand Up @@ -1007,17 +1007,18 @@ impl Metadata {
self.file_type().is_file()
}

/// Returns `true` if this metadata is for a symbolic link file.
/// Returns `true` if this metadata is for a symbolic link.
///
/// # Examples
///
/// ```no_run
/// #![feature(is_symlink)]
/// use std::fs;
/// use std::path::Path;
/// use std::os::unix::fs::symlink;
///
/// fn main() -> std::io::Result<()> {
/// let link_path = Path::new("/link");
/// let link_path = Path::new("link");
/// symlink("/origin_does_not_exists/", link_path)?;
///
/// let metadata = fs::symlink_metadata(link_path)?;
Expand Down
9 changes: 5 additions & 4 deletions library/std/src/path.rs
Expand Up @@ -2568,23 +2568,24 @@ impl Path {
fs::metadata(self).map(|m| m.is_dir()).unwrap_or(false)
}

/// Returns true if the path exists on disk and is pointing at a symbolic link file.
/// Returns true if the path exists on disk and is pointing at a symbolic link.
/// This method can alse be used to check whether symlink exists.
///
/// This function will not traverse symbolic links.
/// In case of broken symbolic links this will also return true.
/// In case of a broken symbolic link this will also return true.
///
/// If you cannot access the directory containing the file, e.g., because of a
/// permission error, this will return false.
///
/// # Examples
///
/// ```no_run
/// #![feature(is_symlink)]
/// use std::path::Path;
/// use std::os::unix::fs::symlink;
///
/// let link_path = Path::new("/link");
/// symlink("/origin_does_not_exists/", link_path)?;
/// let link_path = Path::new("link");
/// symlink("/origin_does_not_exists/", link_path).unwrap();
/// assert_eq!(link_path.is_symlink(), true);
/// assert_eq!(link_path.exists(), false);
/// ```
Expand Down

0 comments on commit a0958df

Please sign in to comment.