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

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

    pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> Result<()>

Rename a file or directory to a new name, replacing the original file if `to` already exists.

This will not work if the new name is on a different mount point.

# Platform-specific behavior

This function currently corresponds to the `rename` function on Unix and the `MoveFileEx` function with the `MOVEFILE_REPLACE_EXISTING` flag on Windows.

Because of this, the behavior when both `from` and `to` exist differs. On Unix, if `from` is a directory, `to` must also be an (empty) directory. If `from` is not a directory, `to` must also be not a directory. In contrast, on Windows, `from` can be anything, but `to` must not be a directory.

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:

- `from` does not exist.
- The user lacks permissions to view contents.
- `from` and `to` are on separate filesystems.

# Examples

    use std::fs;

    fn main() -> std::io::Result<()> {
        fs::rename("a.txt", "b.txt")?; // Rename a.txt to 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`)