autodoc.git / modref.xml

version» Context lines:

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-10-28' version='Pike v8.0.1079'> + <manual time-stamp='2020-10-31' version='Pike v8.0.1085'>    <dir name='./ignored'>    <file name='./ignored/ignored'>    <chapter number='1' title='ignored'>    <autodoc>   <namespace name=''>   <doc><text><p>Symbols implicitly inherited from the virtual base class.</p>   <p> These symbols exist mainly to simplify implementation of    the corresponding lfuns.</p>   </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p>   </text></group></doc>
autodoc.git/modref.xml:2392:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='predef::Crypto.CBC'>Crypto.CBC</classname></inherit>   </docgroup>   </class>   <class name='DHKeyExchange'>   <doc><text><p>Implements Diffie-Hellman key-exchange.</p>   <p> The following key exchange methods are implemented here: -  <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p> +  <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='p'><type><object resolved='7.8::SSL.Cipher.DHParameters'>DHParameters</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='DHParameters'>   <doc><text><p>Diffie-Hellman parameters.</p>
autodoc.git/modref.xml:3176:   <variable name='rsa'><type><object resolved='7.8::Crypto.RSA'>Crypto.RSA</object></type></variable>   </docgroup>   <docgroup homogen-name='set_cipher_suite' homogen-type='method'><doc><text><p>Sets the proper authentication method and cipher specification    for the given cipher <ref resolved='7.8::SSL.session.set_cipher_suite.suite'>suite</ref> and <ref>verison</ref>.</p>   </text></doc>   <method name='set_cipher_suite'>   <arguments><argument name='suite'><type><int/></type></argument><argument name='version'><type><or><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is + <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is    supported.</p>   </text></doc>   <method name='set_compression_method'>   <arguments><argument name='compr'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='sslfile'>   <doc><text><p>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.</p>
autodoc.git/modref.xml:9751:   <code><text><p>map(<ref resolved='predef::rows.index'>index</ref>, lambda(mixed x) { return <ref resolved='predef::rows.data'>data</ref>[x]; })</p>   </text></code><p>That is, it indices data on every index in the array index and    returns an array with the results.</p>   </text><group><seealso/><text><p><ref resolved='predef::column'>column()</ref></p>   </text></group></doc>   <method name='rows'>   <arguments><argument name='data'><type><mixed/></type></argument><argument name='index'><type><array/></type></argument></arguments>   <returntype><array/></returntype>   </method>   </docgroup> - <docgroup homogen-name='search' homogen-type='method'><doc><text><p>Search for <ref resolved='predef::search.needle'>needle</ref> in <ref resolved='predef::search.haystack'>haystack</ref>. Return the position of <ref resolved='predef::search.needle'>needle</ref> in -  <ref resolved='predef::search.haystack'>haystack</ref> or <expr>-1</expr> if not found.</p> - <p> If the optional argument <ref resolved='predef::search.start'>start</ref> is present search is started at -  this position.</p> - <mixed name='haystack'><group><type><string/></type><text><p>When <ref resolved='predef::search.haystack'>haystack</ref> is a string <ref resolved='predef::search.needle'>needle</ref> must be a string or an int, + <docgroup homogen-name='search' homogen-type='method'><doc><text><p>Search for <ref resolved='predef::search.needle'>needle</ref> in <ref resolved='predef::search.haystack'>haystack</ref>.</p> + </text><group><param name='haystack'/><text><p>Item to search in. This can be one of:</p> + <mixed><group><type><string/></type><text><p>When <ref resolved='predef::search.haystack'>haystack</ref> is a string <ref resolved='predef::search.needle'>needle</ref> must be a string or an int,    and the first occurrence of the string or int is returned.</p>   </text></group><group><type><array/></type><text><p>When <ref resolved='predef::search.haystack'>haystack</ref> is an array, <ref resolved='predef::search.needle'>needle</ref> is compared only to    one value at a time in <ref resolved='predef::search.haystack'>haystack</ref>.</p>   </text></group><group><type><mapping/></type><text><p>When <ref resolved='predef::search.haystack'>haystack</ref> is a mapping, <ref resolved='predef::search'>search()</ref> tries to find the index    connected to the data <ref resolved='predef::search.needle'>needle</ref>. That is, it tries to lookup the -  mapping backwards. If <ref resolved='predef::search.needle'>needle</ref> isn't present in the mapping, zero -  is returned, and zero_type() will return 1 for this zero.</p> +  mapping backwards.</p>   </text></group><group><type><object resolved='predef::search'/></type><text><p>When <ref resolved='predef::search.haystack'>haystack</ref> is an object implementing <ref resolved='lfun::_search'>lfun::_search()</ref>, -  the result of calling <ref resolved='lfun::_search'>lfun::_search()</ref> with <ref resolved='predef::search.needle'>needle</ref> will -  be returned.</p> +  the result of calling <ref resolved='lfun::_search'>lfun::_search()</ref> with <ref resolved='predef::search.needle'>needle</ref> and <ref resolved='predef::search.start'>start</ref> +  will be returned.</p>   <p> If <ref resolved='predef::search.haystack'>haystack</ref> is an object that doesn't implement <ref resolved='lfun::_search'>lfun::_search()</ref>    it is assumed to be an <ref resolved='predef::Iterator'>Iterator</ref>, and implement    <ref resolved='predef::Iterator.index'>Iterator()-&gt;index()</ref>, <ref resolved='predef::Iterator.value'>Iterator()-&gt;value()</ref>, and    <ref resolved='predef::Iterator.next'>Iterator()-&gt;next()</ref>. <ref resolved='predef::search'>search()</ref> will then start comparing    elements with <ref resolved='predef::`=='>`==()</ref> until a match with <ref resolved='predef::search.needle'>needle</ref> is found.    If <ref resolved='predef::search.needle'>needle</ref> is found <ref resolved='predef::search.haystack'>haystack</ref> will be advanced to the element,    and the iterator index will be returned. If <ref resolved='predef::search.needle'>needle</ref> is not -  found, <ref resolved='predef::search.haystack'>haystack</ref> will be advanced to the end (and will thus -  evaluate to false), and a zero with zero_type 1 will be returned.</p> +  found, <ref resolved='predef::search.haystack'>haystack</ref> will be advanced to the end.</p>   </text></group></mixed> - </text><group><note/><text><p>If <ref resolved='predef::search.start'>start</ref> is supplied to an iterator object without an + </text></group><group><param name='start'/><text><p>If the optional argument <ref resolved='predef::search.start'>start</ref> is present search is started at +  this position.</p> + </text></group><group><returns/><text><p>Returns the position of <ref resolved='predef::search.needle'>needle</ref> in <ref resolved='predef::search.haystack'>haystack</ref> if found.</p> + <p> If not found the returned value depends on the type of <ref resolved='predef::search.haystack'>haystack</ref>:</p> + <mixed><group><type><or><string/><array/></or></type><text><p><expr>-1</expr>.</p> + </text></group><group><type><or><mapping/><object resolved='predef::Iterator'>Iterator</object></or></type><text><p><ref resolved='predef::.UNDEFINED'>UNDEFINED</ref>.</p> + </text></group><group><type><object resolved='predef::search'/></type><text><p>The value returned by <ref resolved='lfun::_search'>lfun::_search()</ref>.</p> + </text></group></mixed> + </text></group><group><note/><text><p>If <ref resolved='predef::search.start'>start</ref> is supplied to an iterator object without an    <ref resolved='lfun::_search'>lfun::_search()</ref>, <ref resolved='predef::search.haystack'>haystack</ref> will need to implement    <ref resolved='predef::Iterator.set_index'>Iterator()-&gt;set_index()</ref>.</p>   </text></group><group><note/><text><p>For mappings and object <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref> will be returned when not found.    In all other cases <expr>-1</expr> will be returned when not found.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::indices'>indices()</ref>, <ref resolved='predef::values'>values()</ref>, <ref resolved='predef::zero_type'>zero_type()</ref>, <ref resolved='predef::has_value'>has_value()</ref>,    <ref resolved='predef::has_prefix'>has_prefix()</ref>, <ref resolved='predef::has_suffix'>has_suffix()</ref></p>   </text></group></doc>   <method name='search'>   <arguments><argument name='haystack'><type><string/></type></argument><argument name='needle'><type><or><string/><int/></or></type></argument><argument name='start'><type><or><int/><void/></or></type></argument></arguments>   <returntype><int/></returntype>