1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<!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 `gcc`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Config">
<title>gcc::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'>gcc</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'>gcc</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-14' class='srclink' href='../src/gcc/lib.rs.html#56-65' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Config {
// some fields omitted
}</pre><div class='docblock'><p>Extra configuration to pass to gcc.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl <a class='struct' href='../gcc/struct.Config.html' title='gcc::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='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Construct a new instance of a blank set of configuration.</p>
<p>This builder is finished with the <code>compile</code> function.</p>
</div><h4 id='method.include' class='method'><code>fn <a href='#method.include' class='fnname'>include</a><P: <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/path/struct.Path.html' title='std::path::Path'>Path</a>>>(&mut self, dir: P) -> &mut <a class='struct' href='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Add a directory to the <code>-I</code> or include path for headers</p>
</div><h4 id='method.define' class='method'><code>fn <a href='#method.define' class='fnname'>define</a>(&mut self, var: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, val: <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><&<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>>) -> &mut <a class='struct' href='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Specify a <code>-D</code> variable with an optional value.</p>
</div><h4 id='method.object' class='method'><code>fn <a href='#method.object' class='fnname'>object</a><P: <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/path/struct.Path.html' title='std::path::Path'>Path</a>>>(&mut self, obj: P) -> &mut <a class='struct' href='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Add an arbitrary object file to link in</p>
</div><h4 id='method.flag' class='method'><code>fn <a href='#method.flag' class='fnname'>flag</a>(&mut self, flag: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> &mut <a class='struct' href='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Add an arbitrary flag to the invocation of the compiler</p>
</div><h4 id='method.file' class='method'><code>fn <a href='#method.file' class='fnname'>file</a><P: <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/path/struct.Path.html' title='std::path::Path'>Path</a>>>(&mut self, p: P) -> &mut <a class='struct' href='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Add a file which will be compiled</p>
</div><h4 id='method.cpp' class='method'><code>fn <a href='#method.cpp' class='fnname'>cpp</a>(&mut self, cpp: <a href='http://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a>) -> &mut <a class='struct' href='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Set C++ support.</p>
<p>The other <code>cpp_*</code> options will only become active if this is set to
<code>true</code>.</p>
</div><h4 id='method.cpp_link_stdlib' class='method'><code>fn <a href='#method.cpp_link_stdlib' class='fnname'>cpp_link_stdlib</a>(&mut self, cpp_link_stdlib: <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><&<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>>) -> &mut <a class='struct' href='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Set the standard library to link against when compiling with C++
support.</p>
<p>The default value of this property depends on the current target: On
OS X <code>Some("c++")</code> is used, when compiling for a Visual Studio based
target <code>None</code> is used and for other targets <code>Some("stdc++")</code> is used.</p>
<p>A value of <code>None</code> indicates that no automatic linking should happen,
otherwise cargo will link against the specified library.</p>
<p>The given library name must not contain the <code>lib</code> prefix.</p>
</div><h4 id='method.cpp_set_stdlib' class='method'><code>fn <a href='#method.cpp_set_stdlib' class='fnname'>cpp_set_stdlib</a>(&mut self, cpp_set_stdlib: <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><&<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>>) -> &mut <a class='struct' href='../gcc/struct.Config.html' title='gcc::Config'>Config</a></code></h4>
<div class='docblock'><p>Force the C++ compiler to use the specified standard library.</p>
<p>Setting this option will automatically set <code>cpp_link_stdlib</code> to the same
value.</p>
<p>The default value of this option is always <code>None</code>.</p>
<p>This option has no effect when compiling for a Visual Studio based
target.</p>
<p>This option sets the <code>-stdlib</code> flag, which is only supported by some
compilers (clang, icc) but not by others (gcc). The library will not
detect which compiler is used, as such it is the responsibility of the
caller to ensure that this option is only used in conjuction with a
compiler which supports the <code>-stdlib</code> flag.</p>
<p>A value of <code>None</code> indicates that no specific C++ standard library should
be used, otherwise <code>-stdlib</code> is added to the compile invocation.</p>
<p>The given library name must not contain the <code>lib</code> prefix.</p>
</div><h4 id='method.compile' class='method'><code>fn <a href='#method.compile' class='fnname'>compile</a>(&self, output: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>)</code></h4>
<div class='docblock'><p>Run the compiler, generating the file <code>output</code></p>
<p>The name <code>output</code> must begin with <code>lib</code> and end with <code>.a</code></p>
</div></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 = "gcc";
window.playgroundUrl = "";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script async src="../search-index.js"></script>
</body>
</html>
|