aboutsummaryrefslogtreecommitdiff
path: root/gcc/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'gcc/index.html')
-rw-r--r--gcc/index.html161
1 files changed, 161 insertions, 0 deletions
diff --git a/gcc/index.html b/gcc/index.html
new file mode 100644
index 0000000..1953b95
--- /dev/null
+++ b/gcc/index.html
@@ -0,0 +1,161 @@
+<!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 `gcc` crate.">
+ <meta name="keywords" content="rust, rustlang, rust-lang, gcc">
+
+ <title>gcc - 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'></p><script>window.sidebarCurrent = {name: 'gcc', ty: 'mod', relpath: '../'};</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 mod">
+<h1 class='fqn'><span class='in-band'>Crate <a class='mod' href=''>gcc</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'>&#x2212;</span>]
+ </a>
+ </span><a id='src-0' class='srclink' href='../src/gcc/lib.rs.html#1-498' title='goto source code'>[src]</a></span></h1>
+<div class='docblock'><p>A library for build scripts to compile custom C code</p>
+
+<p>This library is intended to be used as a <code>build-dependencies</code> entry in
+<code>Cargo.toml</code>:</p>
+
+<pre><code class="language-toml">[build-dependencies]
+gcc = &quot;0.2&quot;
+</code></pre>
+
+<p>The purpose of this crate is to provide the utility functions necessary to
+compile C code into a static archive which is then linked into a Rust crate.
+The top-level <code>compile_library</code> function serves as a convenience and more
+advanced configuration is available through the <code>Config</code> builder.</p>
+
+<p>This crate will automatically detect situations such as cross compilation or
+other environment variables set by Cargo and will build code appropriately.</p>
+
+<h1 id="examples" class='section-header'><a
+ href="#examples">Examples</a></h1>
+<p>Use the default configuration:</p>
+<pre class='rust rust-example-rendered'>
+<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>gcc</span>;
+
+<span class='kw'>fn</span> <span class='ident'>main</span>() {
+ <span class='ident'>gcc</span>::<span class='ident'>compile_library</span>(<span class='string'>&quot;libfoo.a&quot;</span>, <span class='kw-2'>&amp;</span>[<span class='string'>&quot;src/foo.c&quot;</span>]);
+}
+</pre>
+
+<p>Use more advanced configuration:</p>
+<pre class='rust rust-example-rendered'>
+<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>gcc</span>;
+
+<span class='kw'>fn</span> <span class='ident'>main</span>() {
+ <span class='ident'>gcc</span>::<span class='ident'>Config</span>::<span class='ident'>new</span>()
+ .<span class='ident'>file</span>(<span class='string'>&quot;src/foo.c&quot;</span>)
+ .<span class='ident'>define</span>(<span class='string'>&quot;FOO&quot;</span>, <span class='prelude-val'>Some</span>(<span class='string'>&quot;bar&quot;</span>))
+ .<span class='ident'>include</span>(<span class='string'>&quot;src&quot;</span>)
+ .<span class='ident'>compile</span>(<span class='string'>&quot;libfoo.a&quot;</span>);
+}
+</pre>
+</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
+<table>
+ <tr class=' module-item'>
+ <td><a class='struct' href='struct.Config.html'
+ title='gcc::Config'>Config</a></td>
+ <td class='docblock short'>
+ <p>Extra configuration to pass to gcc.</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.compile_library.html'
+ title='gcc::compile_library'>compile_library</a></td>
+ <td class='docblock short'>
+ <p>Compile a library from the given set of input C files.</p>
+
+ </td>
+ </tr>
+ </table></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>&larrb;</dt>
+ <dd>Move up in search results</dd>
+ <dt>&rarrb;</dt>
+ <dd>Move down in search results</dd>
+ <dt>&#9166;</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 = "gcc";
+ 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