Path methods — symlinks improvement

[maxwase]

This PR adds symlink method for the Path.

Tracking issue: #85748
For the discussion you can see internals topic

P.S.
I'm not fully sure about stable attribute, correct me if I'm wrong.

[rust-highfive]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

[m-ou-se]

Did you test this on a regular file? This also returns true for regular files, on Unix at least.

[m-ou-se]

You'll have to look at the metadata itself (using .file_type().is_symlink()) to check if it's a symlink. symlink_metadata returns metadata about any file, not just symlinks. It just does not follow symlinks to allow you to get the metadata on symlinks too, unlike the regular metadata function.

[m-ou-se]

For the stability attribute: You'll have to come up with a new feature name (e.g. is_symlink or something).

Feel free to open a tracking issue for it.

For completeness, it's probably good to also add this function to std::fs::Metadata. That one also has both is_dir and is_file, but not is_symlink. You can do that in the same PR and in the same tracking issue, if you want.

[maxwase]

Thank you, @m-ou-se, for your remarks, I've changed implementation and added an issue.

[m-ou-se]

Thanks!

Looks good. I only have a few tiny comments on the documentation left:

[m-ou-se]

Thanks!

@bors r+

[bors]

📌 Commit f3c1db3 has been approved by m-ou-se

[bors]

⌛ Testing commit f3c1db3 with merge 6ff500ed65c5e8c788456933c0e3ff983cfd7018...

[bors]

💔 Test failed - checks-actions

[m-ou-se]

Ah, the example doesn't compile on non-unix targets.

You could replace the /// ```no_run line with:

    #[cfg_attr(unix, doc = "```no_run")]
    #[cfg_attr(not(unix), doc = "```ignore")]

Here's an example:

rust/library/std/src/os/unix/net/stream.rs

Lines 365 to 371 in b17d9c1

	/// # Examples
	///
	#[cfg_attr(any(target_os = "android", target_os = "linux"), doc = "```no_run")]
	#[cfg_attr(not(any(target_os = "android", target_os = "linux")), doc = "```ignore")]
	/// #![feature(unix_socket_ancillary_data)]
	/// use std::os::unix::net::UnixStream;
	///

[m-ou-se]

@bors r+

[bors]

📌 Commit 01435fc has been approved by m-ou-se

[bors]

⌛ Testing commit 01435fc with merge 88ba8ad...

[bors]

☀️ Test successful - checks-actions
Approved by: m-ou-se
Pushing 88ba8ad to master...