edlang/git2/opts/fn.set_search_path.html
2024-03-27 11:50:56 +00:00

16 lines
5.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Set the search path for a level of config data. The search path applied to shared attributes and ignore files, too."><title>set_search_path in git2::opts - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-5bc39a1768837dd0.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="git2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.0 (aedd173a2 2024-03-17)" data-channel="1.77.0" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../git2/index.html">git2</a><span class="version">0.18.3</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In git2::opts</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../git2/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">git2</a>::<wbr><a href="index.html">opts</a>::<wbr><a class="fn" href="#">set_search_path</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/git2/opts.rs.html#23-34">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub unsafe fn set_search_path&lt;P&gt;(
level: <a class="enum" href="../enum.ConfigLevel.html" title="enum git2::ConfigLevel">ConfigLevel</a>,
path: P
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.77.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.77.0/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.Error.html" title="struct git2::Error">Error</a>&gt;<div class="where">where
P: <a class="trait" href="../trait.IntoCString.html" title="trait git2::IntoCString">IntoCString</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Set the search path for a level of config data. The search path applied to
shared attributes and ignore files, too.</p>
<p><code>level</code> must be one of <a href="../enum.ConfigLevel.html#variant.System" title="variant git2::ConfigLevel::System"><code>ConfigLevel::System</code></a>, <a href="../enum.ConfigLevel.html#variant.Global" title="variant git2::ConfigLevel::Global"><code>ConfigLevel::Global</code></a>,
<a href="../enum.ConfigLevel.html#variant.XDG" title="variant git2::ConfigLevel::XDG"><code>ConfigLevel::XDG</code></a>, <a href="../enum.ConfigLevel.html#variant.ProgramData" title="variant git2::ConfigLevel::ProgramData"><code>ConfigLevel::ProgramData</code></a>.</p>
<p><code>path</code> lists directories delimited by <code>GIT_PATH_LIST_SEPARATOR</code>.
Use magic path <code>$PATH</code> to include the old value of the path
(if you want to prepend or append, for instance).</p>
<p>This function is unsafe as it mutates the global state but cannot guarantee
thread-safety. It needs to be externally synchronized with calls to access
the global state.</p>
</div></details></section></div></main></body></html>