<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>apt: IndexTarget Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">apt  <span id="projectnumber">1.4.6</span> </div> <div id="projectbrief">commandline package manager</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="classIndexTarget-members.xhtml">List of all members</a> </div> <div class="headertitle"> <div class="title">IndexTarget Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Information about an index file. <a href="classIndexTarget.xhtml#details">More...</a></p> <p><code>#include <<a class="el" href="indexfile_8h_source.xhtml">apt-pkg/indexfile.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:ab1c443e250d6e14cec905406a57e0a28"><td class="memItemLeft" align="right" valign="top"><a id="ab1c443e250d6e14cec905406a57e0a28"></a>enum  </td><td class="memItemRight" valign="bottom"><b>OptionKeys</b> { <br />   <b>SITE</b>, <b>RELEASE</b>, <b>COMPONENT</b>, <b>LANGUAGE</b>, <br />   <b>ARCHITECTURE</b>, <b>BASE_URI</b>, <b>REPO_URI</b>, <b>CREATED_BY</b>, <br />   <b>TARGET_OF</b>, <b>FILENAME</b>, <b>EXISTING_FILENAME</b>, <b>PDIFFS</b>, <br />   <b>COMPRESSIONTYPES</b>, <b>DEFAULTENABLED</b>, <b>SOURCESENTRY</b>, <b>BY_HASH</b>, <br />   <b>KEEPCOMPRESSEDAS</b>, <b>FALLBACK_OF</b>, <b>IDENTIFIER</b>, <b>ALLOW_INSECURE</b>, <br />   <b>ALLOW_WEAK</b>, <b>ALLOW_DOWNGRADE_TO_INSECURE</b> <br /> }</td></tr> <tr class="separator:ab1c443e250d6e14cec905406a57e0a28"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ae28c9408b1d79efa57b369686022b88c"><td class="memItemLeft" align="right" valign="top"><a id="ae28c9408b1d79efa57b369686022b88c"></a>  </td><td class="memItemRight" valign="bottom"><b>IndexTarget</b> (std::string const &<a class="el" href="classIndexTarget.xhtml#ac440ac0ee12cd359222c7fed14141811">MetaKey</a>, std::string const &<a class="el" href="classIndexTarget.xhtml#a9248dc77e748314774ae2c9b1618e6a9">ShortDesc</a>, std::string const &LongDesc, std::string const &<a class="el" href="classURI.xhtml">URI</a>, bool const <a class="el" href="classIndexTarget.xhtml#a2b4fd5d72b64352ddc4c2d2670c3359b">IsOptional</a>, bool const <a class="el" href="classIndexTarget.xhtml#a6f85944ab4004ae5371b34661e18306e">KeepCompressed</a>, std::map< std::string, std::string > const &<a class="el" href="classIndexTarget.xhtml#aa3a841efcdba1c5b4f6895a7b50dcfac">Options</a>)</td></tr> <tr class="separator:ae28c9408b1d79efa57b369686022b88c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8f5c15aacc50278b569919af94b40eff"><td class="memItemLeft" align="right" valign="top"><a id="a8f5c15aacc50278b569919af94b40eff"></a> std::string </td><td class="memItemRight" valign="bottom"><b>Option</b> (OptionKeys const Key) const</td></tr> <tr class="separator:a8f5c15aacc50278b569919af94b40eff"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac643cadcd6ec9eae1d9646d79a434ed6"><td class="memItemLeft" align="right" valign="top"><a id="ac643cadcd6ec9eae1d9646d79a434ed6"></a> bool </td><td class="memItemRight" valign="bottom"><b>OptionBool</b> (OptionKeys const Key) const</td></tr> <tr class="separator:ac643cadcd6ec9eae1d9646d79a434ed6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0ca1a7beeb333c7d104d171cdfad293b"><td class="memItemLeft" align="right" valign="top"><a id="a0ca1a7beeb333c7d104d171cdfad293b"></a> std::string </td><td class="memItemRight" valign="bottom"><b>Format</b> (std::string format) const</td></tr> <tr class="separator:a0ca1a7beeb333c7d104d171cdfad293b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:aaf8eea5037c53d12d3f31ab9e032712c"><td class="memItemLeft" align="right" valign="top"><a id="aaf8eea5037c53d12d3f31ab9e032712c"></a> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIndexTarget.xhtml#aaf8eea5037c53d12d3f31ab9e032712c">URI</a></td></tr> <tr class="memdesc:aaf8eea5037c53d12d3f31ab9e032712c"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="classURI.xhtml">URI</a> from which the index file can be downloaded. <br /></td></tr> <tr class="separator:aaf8eea5037c53d12d3f31ab9e032712c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a72a1a381861908396ddca53a1fa28f97"><td class="memItemLeft" align="right" valign="top"><a id="a72a1a381861908396ddca53a1fa28f97"></a> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIndexTarget.xhtml#a72a1a381861908396ddca53a1fa28f97">Description</a></td></tr> <tr class="memdesc:a72a1a381861908396ddca53a1fa28f97"><td class="mdescLeft"> </td><td class="mdescRight">A description of the index file. <br /></td></tr> <tr class="separator:a72a1a381861908396ddca53a1fa28f97"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9248dc77e748314774ae2c9b1618e6a9"><td class="memItemLeft" align="right" valign="top"><a id="a9248dc77e748314774ae2c9b1618e6a9"></a> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIndexTarget.xhtml#a9248dc77e748314774ae2c9b1618e6a9">ShortDesc</a></td></tr> <tr class="memdesc:a9248dc77e748314774ae2c9b1618e6a9"><td class="mdescLeft"> </td><td class="mdescRight">A shorter description of the index file. <br /></td></tr> <tr class="separator:a9248dc77e748314774ae2c9b1618e6a9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac440ac0ee12cd359222c7fed14141811"><td class="memItemLeft" align="right" valign="top"><a id="ac440ac0ee12cd359222c7fed14141811"></a> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIndexTarget.xhtml#ac440ac0ee12cd359222c7fed14141811">MetaKey</a></td></tr> <tr class="memdesc:ac440ac0ee12cd359222c7fed14141811"><td class="mdescLeft"> </td><td class="mdescRight">The key by which this index file should be looked up within the meta index file. <br /></td></tr> <tr class="separator:ac440ac0ee12cd359222c7fed14141811"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2b4fd5d72b64352ddc4c2d2670c3359b"><td class="memItemLeft" align="right" valign="top"><a id="a2b4fd5d72b64352ddc4c2d2670c3359b"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIndexTarget.xhtml#a2b4fd5d72b64352ddc4c2d2670c3359b">IsOptional</a></td></tr> <tr class="memdesc:a2b4fd5d72b64352ddc4c2d2670c3359b"><td class="mdescLeft"> </td><td class="mdescRight">Is it okay if the file isn't found in the meta index. <br /></td></tr> <tr class="separator:a2b4fd5d72b64352ddc4c2d2670c3359b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6f85944ab4004ae5371b34661e18306e"><td class="memItemLeft" align="right" valign="top"><a id="a6f85944ab4004ae5371b34661e18306e"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIndexTarget.xhtml#a6f85944ab4004ae5371b34661e18306e">KeepCompressed</a></td></tr> <tr class="memdesc:a6f85944ab4004ae5371b34661e18306e"><td class="mdescLeft"> </td><td class="mdescRight">If the file is downloaded compressed, do not unpack it. <br /></td></tr> <tr class="separator:a6f85944ab4004ae5371b34661e18306e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa3a841efcdba1c5b4f6895a7b50dcfac"><td class="memItemLeft" align="right" valign="top"><a id="aa3a841efcdba1c5b4f6895a7b50dcfac"></a> std::map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classIndexTarget.xhtml#aa3a841efcdba1c5b4f6895a7b50dcfac">Options</a></td></tr> <tr class="memdesc:aa3a841efcdba1c5b4f6895a7b50dcfac"><td class="mdescLeft"> </td><td class="mdescRight">options with which this target was created Prefer the usage of #Option if at all possible. Beware: Not all of these options are intended for public use <br /></td></tr> <tr class="separator:aa3a841efcdba1c5b4f6895a7b50dcfac"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Information about an index file. </p> </div><hr/>The documentation for this class was generated from the following files:<ul> <li>apt-pkg/<a class="el" href="indexfile_8h_source.xhtml">indexfile.h</a></li> <li>apt-pkg/indexfile.cc</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>