diff options
Diffstat (limited to 'pkg_config/struct.Config.html')
-rw-r--r-- | pkg_config/struct.Config.html | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/pkg_config/struct.Config.html b/pkg_config/struct.Config.html new file mode 100644 index 0000000..ff49efa --- /dev/null +++ b/pkg_config/struct.Config.html @@ -0,0 +1,127 @@ +<!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 `Config` struct in crate `pkg_config`."> + <meta name="keywords" content="rust, rustlang, rust-lang, Config"> + + <title>pkg_config::Config - Rust</title> + + <link rel="stylesheet" type="text/css" href="../main.css"> + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <section class="sidebar"> + + <p class='location'><a href='index.html'>pkg_config</a></p><script>window.sidebarCurrent = {name: 'Config', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script> + </section> + + <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 struct"> +<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>pkg_config</a>::<wbr><a class='struct' href=''>Config</a></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 id='src-31' class='srclink' href='../src/pkg_config/lib.rs.html#70-74' title='goto source code'>[src]</a></span></h1> +<pre class='rust struct'>pub struct Config { + // some fields omitted +}</pre><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl <a class='struct' href='../pkg_config/struct.Config.html' title='pkg_config::Config'>Config</a></code></h3><div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>() -> <a class='struct' href='../pkg_config/struct.Config.html' title='pkg_config::Config'>Config</a></code></h4> +<div class='docblock'><p>Creates a new set of configuration options which are all initially set +to "blank".</p> +</div><h4 id='method.statik' class='method'><code>fn <a href='#method.statik' class='fnname'>statik</a>(&mut self, statik: <a href='http://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a>) -> &mut <a class='struct' href='../pkg_config/struct.Config.html' title='pkg_config::Config'>Config</a></code></h4> +<div class='docblock'><p>Indicate whether the <code>--static</code> flag should be passed.</p> + +<p>This will override the inference from environment variables described in +the crate documentation.</p> +</div><h4 id='method.atleast_version' class='method'><code>fn <a href='#method.atleast_version' class='fnname'>atleast_version</a>(&mut self, vers: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> &mut <a class='struct' href='../pkg_config/struct.Config.html' title='pkg_config::Config'>Config</a></code></h4> +<div class='docblock'><p>Indicate that the library must be at least version <code>vers</code>.</p> +</div><h4 id='method.arg' class='method'><code>fn <a href='#method.arg' class='fnname'>arg</a><S: <a class='trait' href='http://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html' title='core::convert::AsRef'>AsRef</a><<a class='struct' href='http://doc.rust-lang.org/nightly/std/ffi/os_str/struct.OsStr.html' title='std::ffi::os_str::OsStr'>OsStr</a>>>(&mut self, arg: S) -> &mut <a class='struct' href='../pkg_config/struct.Config.html' title='pkg_config::Config'>Config</a></code></h4> +<div class='docblock'><p>Add an argument to pass to pkg-config.</p> + +<p>It's placed after all of the arguments generated by this library.</p> +</div><h4 id='method.find' class='method'><code>fn <a href='#method.find' class='fnname'>find</a>(&self, name: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a class='struct' href='../pkg_config/struct.Library.html' title='pkg_config::Library'>Library</a>, <a class='struct' href='http://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>></code></h4> +<div class='docblock'><p>Run <code>pkg-config</code> to find the library <code>name</code>.</p> + +<p>This will use all configuration previously set to specify how +<code>pkg-config</code> is run.</p> +</div><h4 id='method.get_variable' class='method'><code>fn <a href='#method.get_variable' class='fnname'>get_variable</a>(package: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, variable: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> <a class='enum' href='http://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a class='struct' href='http://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>, <a class='struct' href='http://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>></code></h4> +<div class='docblock'><p>Run <code>pkg-config</code> to get the value of a variable from a package using +--variable.</p> +</div></div><h2 id='implementations'>Trait Implementations</h2><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='struct' href='../pkg_config/struct.Config.html' title='pkg_config::Config'>Config</a></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone' class='fnname'>clone</a>(&self) -> <a class='struct' href='../pkg_config/struct.Config.html' title='pkg_config::Config'>Config</a></code></h4> +<h4 id='method.clone_from' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code></h4> +</div></section> + <section id='search' class="content hidden"></section> + + <section class="footer"></section> + + <div id="help" class="hidden"> + <div class="shortcuts"> + <h1>Keyboard shortcuts</h1> + <dl> + <dt>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</dd> + </dl> + </div> + <div class="infos"> + <h1>Search tricks</h1> + <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>typedef</code> (or + <code>tdef</code>). + </p> + <p> + Search functions by type signature (e.g. + <code>vec -> usize</code>) + </p> + </div> + </div> + + + + <script> + window.rootPath = "../"; + window.currentCrate = "pkg_config"; + window.playgroundUrl = ""; + </script> + <script src="../jquery.js"></script> + <script src="../main.js"></script> + + <script async src="../search-index.js"></script> +</body> +</html>
\ No newline at end of file |