std::fs::read_link - Rust
Description: API documentation for the Rust `read_link` fn in crate `std`.
Keywords: rust, rustlang, rust-lang, read_link

# Function std::fs::read_link 1.0.0 [−] [src]

    pub fn read_link<P: AsRef<Path>>(path: P) -> Result<PathBuf>

Reads a symbolic link, returning the file that the link points to.

# Platform-specific behavior

This function currently corresponds to the `readlink` function on Unix and the `CreateFile` function with `FILE_FLAG_OPEN_REPARSE_POINT` and `FILE_FLAG_BACKUP_SEMANTICS` flags on Windows. Note that, this may change in the future.

# Errors

This function will return an error in the following situations, but is not limited to just these cases:

- `path` is not a symbolic link.
- `path` does not exist.

# Examples

    use std::fs;

    let path = fs::read_link("a.txt")?;Run

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)