Back to Bazel

TemplateVariableInfo

docs/versions/8.3.0/rules/lib/providers/TemplateVariableInfo.mdx

9.1.11.4 KB
Original Source
<html devsite> <head> <meta name="project_path" value="/_project.yaml"> <meta name="book_path" value="/versions/8.3.0/_book.yaml"> </head> <body> <h1 class="page-title" id="modules.TemplateVariableInfo">TemplateVariableInfo</h1>

{% dynamic setvar source_file "src/main/java/com/google/devtools/build/lib/starlarkbuildapi/TemplateVariableInfoApi.java" %} {% dynamic setvar version "8.3.0" %} {% dynamic setvar original_path "/rules/lib/providers/TemplateVariableInfo" %} {% include "_buttons.html" %}

<!-- {% raw %} -->

Encapsulates template variables, that is, variables that can be referenced by strings like <code>$(VARIABLE)</code> in BUILD files and expanded by <code>ctx.expand_make_variables</code> and implicitly in certain attributes of built-in rules.</p><p><code>TemplateVariableInfo</code> can be created by calling its eponymous constructor with a string-to-string dict as an argument that specifies the variables provided.</p><p>Example: <code>platform_common.TemplateVariableInfo({'FOO': 'bar'})</code></p>

<h2>Members</h2> <ul> <li> <a href="#variables">variables</a> </li> </ul>
  <h2 id="variables">variables</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../core/dict.html">dict</a> TemplateVariableInfo.variables</pre></p>

Returns the make variables defined by this target as a dictionary with string keys and string values
</body> </html> <!-- {% endraw %} -->