<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `env` mod in crate `std`.">
<meta name="keywords" content="rust, rustlang, rust-lang, env">
<title>std::env - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
<a href='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Module env</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>std</a></p><script>window.sidebarCurrent = {name: 'env', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>std</a>::<wbr><a class="mod" href=''>env</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../../src/std/env.rs.html#11-1065' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Inspection and manipulation of the process's environment.</p>
<p>This module contains functions to inspect various aspects such as
environment variables, process arguments, the current directory, and various
other important directories.</p>
<p>There are several functions and structs in this module that have a
counterpart ending in <code>os</code>. Those ending in <code>os</code> will return an <a href="../../std/ffi/struct.OsString.html"><code>OsString</code></a>
and those without will be returning a <a href="../string/struct.String.html"><code>String</code></a>.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="consts/index.html"
title='mod std::env::consts'>consts</a></td>
<td class='docblock-short'>
<p>Constants associated with the current target</p>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Args.html"
title='struct std::env::Args'>Args</a></td>
<td class='docblock-short'>
<p>An iterator over the arguments of a process, yielding a <a href="../string/struct.String.html"><code>String</code></a> value for
each argument.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ArgsOs.html"
title='struct std::env::ArgsOs'>ArgsOs</a></td>
<td class='docblock-short'>
<p>An iterator over the arguments of a process, yielding an <a href="../ffi/struct.OsString.html"><code>OsString</code></a> value
for each argument.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.JoinPathsError.html"
title='struct std::env::JoinPathsError'>JoinPathsError</a></td>
<td class='docblock-short'>
<p>The error type for operations on the <code>PATH</code> variable. Possibly returned from
the <a href="fn.join_paths.html"><code>env::join_paths</code></a> function.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SplitPaths.html"
title='struct std::env::SplitPaths'>SplitPaths</a></td>
<td class='docblock-short'>
<p>An iterator that splits an environment variable into paths according to
platform-specific conventions.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Vars.html"
title='struct std::env::Vars'>Vars</a></td>
<td class='docblock-short'>
<p>An iterator over a snapshot of the environment variables of this process.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.VarsOs.html"
title='struct std::env::VarsOs'>VarsOs</a></td>
<td class='docblock-short'>
<p>An iterator over a snapshot of the environment variables of this process.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.VarError.html"
title='enum std::env::VarError'>VarError</a></td>
<td class='docblock-short'>
<p>The error type for operations interacting with environment variables.
Possibly returned from the <a href="fn.var.html"><code>env::var</code></a> function.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.args.html"
title='fn std::env::args'>args</a></td>
<td class='docblock-short'>
<p>Returns the arguments which this program was started with (normally passed
via the command line).</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.args_os.html"
title='fn std::env::args_os'>args_os</a></td>
<td class='docblock-short'>
<p>Returns the arguments which this program was started with (normally passed
via the command line).</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.current_dir.html"
title='fn std::env::current_dir'>current_dir</a></td>
<td class='docblock-short'>
<p>Returns the current working directory as a <a href="../../std/path/struct.PathBuf.html"><code>PathBuf</code></a>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.current_exe.html"
title='fn std::env::current_exe'>current_exe</a></td>
<td class='docblock-short'>
<p>Returns the full filesystem path of the current running executable.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.home_dir.html"
title='fn std::env::home_dir'>home_dir</a></td>
<td class='docblock-short'>
<p>Returns the path of the current user's home directory if known.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.join_paths.html"
title='fn std::env::join_paths'>join_paths</a></td>
<td class='docblock-short'>
<p>Joins a collection of <a href="../../std/path/struct.Path.html"><code>Path</code></a>s appropriately for the <code>PATH</code>
environment variable.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.remove_var.html"
title='fn std::env::remove_var'>remove_var</a></td>
<td class='docblock-short'>
<p>Removes an environment variable from the environment of the currently running process.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.set_current_dir.html"
title='fn std::env::set_current_dir'>set_current_dir</a></td>
<td class='docblock-short'>
<p>Changes the current working directory to the specified path.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.set_var.html"
title='fn std::env::set_var'>set_var</a></td>
<td class='docblock-short'>
<p>Sets the environment variable <code>k</code> to the value <code>v</code> for the currently running
process.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.split_paths.html"
title='fn std::env::split_paths'>split_paths</a></td>
<td class='docblock-short'>
<p>Parses input according to platform conventions for the <code>PATH</code>
environment variable.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.temp_dir.html"
title='fn std::env::temp_dir'>temp_dir</a></td>
<td class='docblock-short'>
<p>Returns the path of a temporary directory.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.var.html"
title='fn std::env::var'>var</a></td>
<td class='docblock-short'>
<p>Fetches the environment variable <code>key</code> from the current process.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.var_os.html"
title='fn std::env::var_os'>var_os</a></td>
<td class='docblock-short'>
<p>Fetches the environment variable <code>key</code> from the current process, returning
<a href="../option/enum.Option.html#variant.None"><code>None</code></a> if the variable isn't set.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.vars.html"
title='fn std::env::vars'>vars</a></td>
<td class='docblock-short'>
<p>Returns an iterator of (variable, value) pairs of strings, for all the
environment variables of the current process.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.vars_os.html"
title='fn std::env::vars_os'>vars_os</a></td>
<td class='docblock-short'>
<p>Returns an iterator of (variable, value) pairs of OS strings, for all the
environment variables of the current process.</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "std";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
fdedb3cf2140df9b6d419a2338ab1caa
>
files
>
3868
