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

# Function std::env::join_paths 1.0.0 [−] [src]

    pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError> where
        I: IntoIterator<Item = T>,
        T: AsRef<OsStr>,

Joins a collection of `Path`s appropriately for the `PATH` environment variable.

# Errors

Returns an `Err` (containing an error message) if one of the input `Path`s contains an invalid character for constructing the `PATH` variable (a double quote on Windows or a colon on Unix).

# Examples

Joining paths on a Unix-like platform:

    use std::env;
    use std::ffi::OsString;
    use std::path::Path;

    let paths = [Path::new("/bin"), Path::new("/usr/bin")];
    let path_os_string = env::join_paths(paths.iter()).unwrap();
    assert_eq!(path_os_string, OsString::from("/bin:/usr/bin"));Run

Joining a path containing a colon on a Unix-like platform results in an error:

    use std::env;
    use std::path::Path;

    let paths = [Path::new("/bin"), Path::new("/usr/bi:n")];
    assert!(env::join_paths(paths.iter()).is_err());Run

Using `env::join_paths` with `env::spit_paths` to append an item to the `PATH` environment variable:

    use std::env;
    use std::path::PathBuf;

    if let Some(path) = env::var_os("PATH") {
        let mut paths = env::split_paths(&path).collect::<Vec<_>>();
        paths.push(PathBuf::from("/home/xyz/bin"));
        let new_path = env::join_paths(paths).unwrap();
        env::set_var("PATH", &new_path);
    }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
+ / -
  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`)