53 lines
11 KiB
HTML
53 lines
11 KiB
HTML
<!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="Put your app’s data in the right place on every platform"><meta name="keywords" content="rust, rustlang, rust-lang, app_dirs2"><title>app_dirs2 - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../app_dirs2/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Crate app_dirs2</h2><div class="block version"><div class="narrow-helper"></div><p>Version 2.4.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all app_dirs2's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="app_dirs2" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../app_dirs2/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">app_dirs2</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><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/app_dirs2/lib.rs.html#1-62" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><em>Put your app’s data in the right place on every platform</em></p>
|
||
<h2 id="usage" class="section-header"><a href="#usage">Usage</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">app_dirs2</span>::<span class="kw-2">*</span>; <span class="comment">// or app_dirs::* if you've used package alias in Cargo.toml</span>
|
||
|
||
<span class="kw">const</span> <span class="ident">APP_INFO</span>: <span class="ident">AppInfo</span> <span class="op">=</span> <span class="ident">AppInfo</span>{<span class="ident">name</span>: <span class="string">"CoolApp"</span>, <span class="ident">author</span>: <span class="string">"SuperDev"</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span> () {
|
||
<span class="comment">// Where should I store my app's per-user configuration data?</span>
|
||
<span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">get_app_root</span>(<span class="ident">AppDataType::UserConfig</span>, <span class="kw-2">&</span><span class="ident">APP_INFO</span>));
|
||
<span class="comment">// Windows: "%APPDATA%\SuperDev\CoolApp"</span>
|
||
<span class="comment">// (e.g.: "C:\Users\Rusty\AppData\Roaming\SuperDev\CoolApp")</span>
|
||
<span class="comment">// macOS: "$HOME/Library/Application Support/CoolApp"</span>
|
||
<span class="comment">// (e.g.: "/Users/Rusty/Library/Application Support/CoolApp")</span>
|
||
<span class="comment">// *nix: "$HOME/.config/CoolApp" (or "$XDG_CONFIG_HOME/CoolApp", if defined)</span>
|
||
<span class="comment">// (e.g.: "/home/rusty/.config/CoolApp")</span>
|
||
|
||
<span class="comment">// How about nested cache data?</span>
|
||
<span class="macro">println!</span>(<span class="string">"{:?}"</span>, <span class="ident">get_app_dir</span>(<span class="ident">AppDataType::UserCache</span>, <span class="kw-2">&</span><span class="ident">APP_INFO</span>, <span class="string">"cache/images"</span>));
|
||
<span class="comment">// Windows: "%LOCALAPPDATA%\SuperDev\CoolApp\cache\images"</span>
|
||
<span class="comment">// (e.g.: "C:\Users\Rusty\AppData\Local\SuperDev\CoolApp\cache\images")</span>
|
||
<span class="comment">// macOS: "$HOME/Library/Caches/CoolApp/cache/images"</span>
|
||
<span class="comment">// (e.g.: "/Users/Rusty/Library/Caches/CoolApp/cache/images")</span>
|
||
<span class="comment">// *nix: "$HOME/.cache/CoolApp/cache/images"</span>
|
||
<span class="comment">// (or "$XDG_CACHE_HOME/CoolApp/cache/images", if defined)</span>
|
||
<span class="comment">// (e.g.: "/home/rusty/.cache/CoolApp/cache/images")</span>
|
||
|
||
<span class="comment">// Remove "get_" prefix to recursively create nonexistent directories:</span>
|
||
<span class="comment">// app_root(AppDataType::UserConfig, &APP_INFO)</span>
|
||
<span class="comment">// app_dir(AppDataType::UserCache, &APP_INFO, "cache/images")</span>
|
||
}</code></pre></div>
|
||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AppInfo.html" title="app_dirs2::AppInfo struct">AppInfo</a></div><div class="item-right docblock-short"><p>Struct that holds information about your app.</p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AppDataType.html" title="app_dirs2::AppDataType enum">AppDataType</a></div><div class="item-right docblock-short"><p>Enum specifying the type of app data you want to store.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AppDirsError.html" title="app_dirs2::AppDirsError enum">AppDirsError</a></div><div class="item-right docblock-short"><p>Error type for any <code>app_dirs</code> operation.</p>
|
||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.app_dir.html" title="app_dirs2::app_dir fn">app_dir</a></div><div class="item-right docblock-short"><p>Creates (if necessary) and returns path to <strong>app-specific</strong> data
|
||
<strong>subdirectory</strong> for provided data type and subdirectory path.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.app_root.html" title="app_dirs2::app_root fn">app_root</a></div><div class="item-right docblock-short"><p>Creates (if necessary) and returns path to <strong>app-specific</strong> data
|
||
directory for provided data type.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.data_root.html" title="app_dirs2::data_root fn">data_root</a></div><div class="item-right docblock-short"><p>Creates (if necessary) and returns path to <strong>top-level</strong> data directory
|
||
for provided data type.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_app_dir.html" title="app_dirs2::get_app_dir fn">get_app_dir</a></div><div class="item-right docblock-short"><p>Returns (but <strong>does not create</strong>) path to <strong>app-specific</strong> data
|
||
<strong>subdirectory</strong> for provided data type and subdirectory path.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_app_root.html" title="app_dirs2::get_app_root fn">get_app_root</a></div><div class="item-right docblock-short"><p>Returns (but <strong>does not create</strong>) path to <strong>app-specific</strong> data directory
|
||
for provided data type.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_data_root.html" title="app_dirs2::get_data_root fn">get_data_root</a></div><div class="item-right docblock-short"><p>Returns (but <strong>does not create</strong>) path to <strong>top-level</strong> data directory for
|
||
provided data type.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sanitized.html" title="app_dirs2::sanitized fn">sanitized</a></div><div class="item-right docblock-short"><p>Returns a cross-platform-filename-safe version of any string.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="app_dirs2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |