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

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

    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;

    fn main() -> std::io::Result<()> {
        let path = fs::read_link("a.txt")?;
        Ok(())
    }

Run