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

# 1.1.0[−][src]Function std::os::unix::fs::symlink

    pub fn symlink<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> Result<()>

This is supported on Unix only.

Creates a new symbolic link on the filesystem.

The `dst` path will be a symbolic link pointing to the `src` path.

# Note

On Windows, you must specify whether a symbolic link points to a file or directory. Use `os::windows::fs::symlink_file` to create a symbolic link to a file, or `os::windows::fs::symlink_dir` to create a symbolic link to a directory. Additionally, the process must have `SeCreateSymbolicLinkPrivilege` in order to be able to create a symbolic link.

# Examples

    use std::os::unix::fs;

    fn main() -> std::io::Result<()> {
        fs::symlink("a.txt", "b.txt")?;
        Ok(())
    }Run

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)