docs/versions/7.1.0/rules/lib/providers/CcInfo.mdx
{% dynamic setvar source_file "src/main/java/com/google/devtools/build/lib/starlarkbuildapi/cpp/CcInfoApi.java" %} {% dynamic setvar version "7.1.0" %} {% dynamic setvar original_path "/rules/lib/providers/CcInfo" %} {% include "_buttons.html" %}
<!-- {% raw %} -->A provider for compilation and linking of C++. This is also a marking provider telling C++ rules that they can depend on the rule with this provider. If it is not intended for the rule to be depended on by C++, the rule should wrap the CcInfo in some other provider.
<h2>Members</h2> <ul> <li> <a href="#CcInfo">CcInfo</a> </li> <li> <a href="#compilation_context">compilation_context</a> </li> <li> <a href="#linking_context">linking_context</a> </li> <li> <a href="#to_json">to_json</a> </li> <li> <a href="#to_proto">to_proto</a> </li> </ul> <h2 id="CcInfo">CcInfo</h2>
<p><pre class="rule-signature"><a class="anchor" href="../providers/CcInfo.html">CcInfo</a> CcInfo(compilation_context=None, linking_context=None, debug_context=None)</pre></p>
The <code>CcInfo</code> constructor.
<!-- hide-from-toc is a class used by DevSite for the public Bazel site
(https://developers.google.com/devsite/reference/styles/headings#hide_headings_from_the_toc) -->
<h3 class="hide-from-toc">Parameters</h3>
<table class="table table-bordered table-condensed table-params">
<colgroup>
<col class="col-param">
<col class="param-description">
</colgroup>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td id="CcInfo.compilation_context">
<code>compilation_context</code>
</td>
<td>
<a class="anchor" href="../builtins/CompilationContext.html">CompilationContext</a>; or <code>None</code>;
default is <code>None</code>
The <code>CompilationContext</code>.
</td>
</tr>
<tr>
<td id="CcInfo.linking_context">
<code>linking_context</code>
</td>
<td>
<a class="anchor" href="../builtins/LinkingContext.html">LinkingContext</a>; or <code>None</code>;
default is <code>None</code>
The <code>LinkingContext</code>.
</td>
</tr>
<tr>
<td id="CcInfo.debug_context">
<code>debug_context</code>
</td>
<td>
DebugContext; or <code>None</code>;
default is <code>None</code>
The <code>DebugContext</code>.
</td>
</tr>
</tbody>
</table>
<h2 id="compilation_context">compilation_context</h2>
<p><pre class="rule-signature"><a class="anchor" href="../builtins/CompilationContext.html">CompilationContext</a> CcInfo.compilation_context</pre></p>
Returns the <code>CompilationContext</code>
<h2 id="linking_context">linking_context</h2>
<p><pre class="rule-signature"><a class="anchor" href="../builtins/LinkingContext.html">LinkingContext</a> CcInfo.linking_context</pre></p>
Returns the <code>LinkingContext</code>
<h2 id="to_json">to_json</h2>
<p><pre class="rule-signature"><a class="anchor" href="../core/string.html">string</a> CcInfo.to_json()</pre></p>
<b>Deprecated</b>. This API is deprecated and will be removed soon. Please do not depend on it. It is <i>disabled</i> with <code>---incompatible_struct_has_no_methods</code>. Use this flag to verify your code is compatible with its imminent removal.
Creates a JSON string from the struct parameter. This method only works if all struct elements (recursively) are strings, ints, booleans, other structs, a list of these types or a dictionary with string keys and values of these types. Quotes and new lines in strings are escaped. Examples:
<pre class=language-python>struct(key=123).to_json() # {"key":123} struct(key=True).to_json() # {"key":true} struct(key=[1, 2, 3]).to_json() # {"key":[1,2,3]} struct(key='text').to_json() # {"key":"text"} struct(key=struct(inner_key='text')).to_json() # {"key":{"inner_key":"text"}} struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_json() # {"key":[{"inner_key":1},{"inner_key":2}]} struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_json() # {"key":{"inner_key":{"inner_inner_key":"text"}}} </pre>.<p>Deprecated: instead, use json.encode(x) or json.encode_indent(x), which work for values other than structs and do not pollute the struct field namespace. <h2 id="to_proto">to_proto</h2>
<p><pre class="rule-signature"><a class="anchor" href="../core/string.html">string</a> CcInfo.to_proto()</pre></p>
<b>Deprecated</b>. This API is deprecated and will be removed soon. Please do not depend on it. It is <i>disabled</i> with <code>---incompatible_struct_has_no_methods</code>. Use this flag to verify your code is compatible with its imminent removal.
Creates a text message from the struct parameter. This method only works if all struct elements (recursively) are strings, ints, booleans, other structs or dicts or lists of these types. Quotes and new lines in strings are escaped. Struct keys are iterated in the sorted order. Examples:
<pre class=language-python>struct(key=123).to_proto() # key: 123 struct(key=True).to_proto() # key: true struct(key=[1, 2, 3]).to_proto() # key: 1 # key: 2 # key: 3 struct(key='text').to_proto() # key: "text" struct(key=struct(inner_key='text')).to_proto() # key { # inner_key: "text" # } struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_proto() # key { # inner_key: 1 # } # key { # inner_key: 2 # } struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_proto() # key { # inner_key { # inner_inner_key: "text" # } # } struct(foo={4: 3, 2: 1}).to_proto() # foo: { # key: 4 # value: 3 # } # foo: { # key: 2 # value: 1 # } </pre><p>Deprecated: use proto.encode_text(x) instead. </body> </html> <!-- {% endraw %} -->