autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:1126:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='8.0::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/autodoc.xml:1743:   <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable>   </docgroup>   <docgroup homogen-type='variable'><doc><text><p>Random cookies, sent and received with the hello-messages.</p>   </text></doc>   <variable name='client_random'><type><string/></type></variable>   <variable name='server_random'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='is_server'/><text><p>Whether this is the server end of the connection or not.</p>   </text></group><group><param name='ctx'/><text><p>The context for the connection.</p>   </text></group><group><param name='min_version'/><text><p>Minimum version of SSL to support. -  Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p>   </text></group><group><param name='max_version'/><text><p>Maximum version of SSL to support.    Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>.</p>   </text></group></doc>   <method name='create'>   <arguments><argument name='is_server'><type><int/></type></argument><argument name='ctx'><type><or><void/><object resolved='7.8::SSL.context'>SSL.context</object></or></type></argument><argument name='min_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument><argument name='max_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='handle_handshake' homogen-type='method'><doc><text><p>Do handshake processing. Type is one of HANDSHAKE_*, data is the    contents of the packet, and raw is the raw packet received (needed
autodoc.git/autodoc.xml:1910:   <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/autodoc.xml:84664:   </docgroup>   <docgroup homogen-name='decode_header' homogen-type='method'><doc><text><p>Decodes the header of the TIFF <ref resolved='predef::Image.TIFF.decode_header.data'>data</ref> into a mapping.</p>   <mapping><group><member><type><int/></type><index>"xsize"</index></member><member><type><int/></type><index>"ysize"</index></member><member><type><int/></type><index>"ImageWidth"</index></member><member><type><int/></type><index>"ImageLength"</index></member><text><p>Size of image in pixels.</p>   </text></group><group><member><type><string/></type><index>"type"</index></member><text><p>File type information as MIME type. Always <expr>"image/tiff"</expr>.</p>   </text></group><group><member><type><string/></type><index>"color_space"</index></member><text><p>Color space of TIFF image. Either <expr>"RGB"</expr> or <expr>"CMYK"</expr>.</p>   </text></group><group><member><type><string/></type><index>"byte_order"</index></member><text><p>Either <expr>"II"</expr> for Little Endian or <expr>"MM"</expr> for Big Endian.</p>   </text></group><group><member><type><int/></type><index>"NewSubfileType"</index></member><member><type><string/></type><index>"BitsPerSample"</index></member><member><type><int/></type><index>"Compression"</index></member><member><type><int/></type><index>"PhotometricInterpretation"</index></member><member><type><string/></type><index>"Make"</index></member><member><type><string/></type><index>"Model"</index></member><member><type><int/></type><index>"SamplesPerPixel"</index></member><member><type><int/></type><index>"ResolutionUnit"</index></member><member><type><string/></type><index>"Software"</index></member><member><type><string/></type><index>"DateTime"</index></member><member><type><int/></type><index>"Predictor"</index></member><member><type><string/></type><index>"XMP"</index></member></group></mapping>   </text></doc>   <method name='decode_header'><modifiers><public/></modifiers>   <arguments><argument name='data'><type><string/></type></argument></arguments> - <returntype><mapping/></returntype> + <returntype><or><mapping/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='"____Image_TIFF"' homogen-type='inherit'>   <inherit name='"____Image_TIFF"'><classname>"____Image_TIFF"</classname></inherit>   </docgroup>   <docgroup homogen-name='tiff_tags' homogen-type='variable'><doc><text><p>Defines TIFF tags to parse.</p>   <mapping><text><p>Lookup from integer TIFF tag to parse information:</p>
autodoc.git/autodoc.xml:124836:   <docgroup homogen-name='validate' homogen-type='method'><doc><text><p>This function validates a JSON object against the JSON schema that was    specified in the Validator's constructor.    If the JSON object is not valid, a string with an error-message is    returned.    If the JSON object is valid, 0 is returned.</p>   </text><group><param name='json'/><text><p>The JSON object to validate.</p>   </text></group><group><returns/><text><p>0, if the json object is valid, and an error-message if it is not valid.</p>   </text></group></doc>   <method name='validate'>   <arguments><argument name='json'><type><mixed/></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_array' homogen-type='method'><doc><text><p>Verify that the specified <tt>value</tt> is an array according to the    specified <tt>schema</tt>.    The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minItems'/><text><p>If <tt>schema</tt> has the property <tt>"minItems"</tt>, then the array must    have at least the specified number of items.</p>   </text></group><group><item name='maxItems'/><text><p>If <tt>schema</tt> has the property <tt>"maxItems"</tt>, then the array must    not have more than the specified number of items.</p>   </text></group><group><item name='items'/><text><p>If <tt>schema</tt> has the property <tt>"items"</tt>, which is an array of    schema objects, then each element in the value array must be valid    according the corresponding schema in the <tt>"items"</tt> array.</p>   </text></group></dl>   </text></doc>   <method name='validate_array'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_integer' homogen-type='method'><doc><text><p>Verify that the specified value is an integer according to the specified    <tt>schema</tt>. This is the similar to <ref resolved='predef::Standards.JSON.Validator.validate_number'>validate_number()</ref>, but the    <tt>value</tt> must be an int and not a float.    The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minimum'/><text><p>If the <tt>schema</tt> has the property <tt>"minimum"</tt>, then the    <tt>value</tt> must be greater than or equal to the specified minimum.</p>   </text></group><group><item name='exclusiveMinimum'/><text><p>If the <tt>schema</tt> has the properties <tt>"minimum"</tt> and    <tt>"exclusiveMinimum"</tt> is <ref resolved='predef::Standards.JSON.true'>Standards.JSON.true</ref>, then the
autodoc.git/autodoc.xml:124876:    <tt>value</tt> must be lower than or equal to the specified maximum.</p>   </text></group><group><item name='exclusiveMaximum'/><text><p>If the <tt>schema</tt> has the properties <tt>"maximum"</tt> and    <tt>"exclusiveMaximum"</tt> is <ref resolved='predef::Standards.JSON.true'>Standards.JSON.true</ref>, then the    <tt>value</tt> must be lower than the specified minimum.</p>   </text></group><group><item name='multipleOf'/><text><p>If <tt>schema</tt> has the property <tt>"multipleOf"</tt>, then the    <tt>value</tt> must be an integer multiple of the specified multpleOf.</p>   </text></group></dl>   </text></doc>   <method name='validate_integer'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_item_type' homogen-type='method'><doc><text><p>Verify that the specified <tt>value</tt> has the correct type that is    defined by <tt>schema-&gt;type</tt>. <tt>schema-&gt;type</tt> can be any of</p>   <ul><group><item/><text><p>"boolean",</p>   </text></group><group><item/><text><p>"integer",</p>   </text></group><group><item/><text><p>"number",</p>   </text></group><group><item/><text><p>"string",</p>   </text></group><group><item/><text><p>"array",</p>   </text></group><group><item/><text><p>"object",</p>   </text></group><group><item/><text><p>"null",</p>   </text></group></ul><p>or an array of these.</p>   </text></doc>   <method name='validate_item_type'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping/></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_number' homogen-type='method'><doc><text><p>Verify that the specified value is a number (integer or float) according    to the specified <tt>schema</tt>.    The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minimum'/><text><p>If the <tt>schema</tt> has the property <tt>"minimum"</tt>, then the    <tt>value</tt> must be greater than or equal to the specified minimum.</p>   </text></group><group><item name='exclusiveMinimum'/><text><p>If the <tt>schema</tt> has the properties <tt>"minimum"</tt> and    <tt>"exclusiveMinimum"</tt> is <ref resolved='predef::Standards.JSON.true'>Standards.JSON.true</ref>, then the    <tt>value</tt> must be greater than the specified minimum.</p>
autodoc.git/autodoc.xml:124914:    <tt>value</tt> must be lower than or equal to the specified maximum.</p>   </text></group><group><item name='exclusiveMaximum'/><text><p>If the <tt>schema</tt> has the properties <tt>"maximum"</tt> and    <tt>"exclusiveMaximum"</tt> is <ref resolved='predef::Standards.JSON.true'>Standards.JSON.true</ref>, then the    <tt>value</tt> must be lower than the specified minimum.</p>   </text></group><group><item name='multipleOf'/><text><p>If <tt>schema</tt> has the property <tt>"multipleOf"</tt>, then the    <tt>value</tt> must be an integer multiple of the specified multpleOf.</p>   </text></group></dl>   </text></doc>   <method name='validate_number'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_object' homogen-type='method'><doc><text><p>Verify that the specified <tt>value</tt> is an object according to the    specified <tt>schema</tt>.    The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minProperties'/><text><p>If <tt>schema</tt> has the property <tt>"minProperties"</tt>, then the    object must have at least the specified number of properties.</p>   </text></group><group><item name='maxProperties'/><text><p>If <tt>schema</tt> has the property <tt>"maxProperties"</tt>, then the    object must not have more than the specified number of items.</p>   </text></group><group><item name='required'/><text><p>If <tt>schema</tt> has the property <tt>"required"</tt>, which is an array
autodoc.git/autodoc.xml:124952:   </text></group><group><item/><text><p>If it is a schema, then any propery of the object that is not    validated by a schema from <tt>"properties"</tt> or    <tt>"patternProperties"</tt> must be validated by the specified schema.</p>   </text></group></ul></text></group></dl>   </text><group><note/><text><p>TODO: We use <ref resolved='predef::Regexp.SimpleRegexp'>Regexp.SimpleRegexp</ref> to handle    <tt>schema-&gt;patternProperties</tt>, but that covers only some part of the    possible regular expressions.</p>   </text></group></doc>   <method name='validate_object'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup> - <docgroup homogen-name='validate_properties' homogen-type='method'><doc><text><p>Verify that the specified value matches the specified <tt>schema</tt>. The -  following properties of <tt>schema</tt> are verified:</p> + <docgroup homogen-name='validate_properties' homogen-type='method'><doc><text><p>Verify that the specified value matches the specified +  <tt>schema</tt>. The following properties of <tt>schema</tt> are +  verified:</p>   <dl><group><item name='type'/><text><p>If the <tt>schema</tt> has a property <tt>"type"</tt>, then the <tt>value</tt>    must match the specified type (see <ref resolved='predef::Standards.JSON.Validator.validate_item_type'>validate_item_type()</ref>).</p> - </text></group><group><item name='allOf'/><text><p>If the <tt>schema</tt> has a property <tt>"allOf"</tt>, which is an array of -  schema objects, then the <tt>value</tt> must match each schema specified -  in that array (via another call to <ref resolved='predef::Standards.JSON.Validator.validate_properties'>validate_properties()</ref>).</p> - </text></group><group><item name='anyOf'/><text><p>If the <tt>schema</tt> has a property <tt>"anyOf"</tt>, which is an array of -  schema objects, then the <tt>value</tt> must match at least one schema -  specified in that array (via another call to + </text></group><group><item name='allOf'/><text><p>If the <tt>schema</tt> has a property <tt>"allOf"</tt>, which is +  an array of schema objects, then the <tt>value</tt> must match +  each schema specified in that array (via another call to    <ref resolved='predef::Standards.JSON.Validator.validate_properties'>validate_properties()</ref>).</p> - </text></group><group><item name='oneOf'/><text><p>If the <tt>schema</tt> has a property <tt>"oneOf"</tt>, which is an array of -  schema objects, then the <tt>value</tt> must match exactly one schema -  specified in that array (via another call to -  <ref resolved='predef::Standards.JSON.Validator.validate_properties'>validate_properties()</ref>).</p> + </text></group><group><item name='anyOf'/><text><p>If the <tt>schema</tt> has a property <tt>"anyOf"</tt>, which is +  an array of schema objects, then the <tt>value</tt> must match +  at least one schema specified in that array (via another +  call to <ref resolved='predef::Standards.JSON.Validator.validate_properties'>validate_properties()</ref>).</p> + </text></group><group><item name='oneOf'/><text><p>If the <tt>schema</tt> has a property <tt>"oneOf"</tt>, which is +  an array of schema objects, then the <tt>value</tt> must match +  exactly one schema specified in that array (via another call +  to <ref resolved='predef::Standards.JSON.Validator.validate_properties'>validate_properties()</ref>).</p>   </text></group><group><item name='not'/><text><p>If the <tt>schema</tt> has a property <tt>"not"</tt>, then the <tt>value</tt>    must not match the schema specified by that property (via another    call to <ref resolved='predef::Standards.JSON.Validator.validate_properties'>validate_properties()</ref>).</p>   </text></group><group><item name='enum'/><text><p>If the <tt>schema</tt> has a property <tt>"enum"</tt>, then the <tt>value</tt>    must be equal to any of the values specified in the enum array.</p>   </text></group></dl> - </text><group><note/><text><p>If the <tt>schema</tt> is empty (i.e., it has none of the above specified -  properties, then the <tt>value</tt> is valid).</p> + </text><group><note/><text><p>If the <tt>schema</tt> is empty (i.e., it has none of the above +  specified properties, then the <tt>value</tt> is valid).</p>   </text></group></doc>   <method name='validate_properties'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping/></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_string' homogen-type='method'><doc><text><p>Verify that the specified value is a string according to the specified    <tt>schema</tt>. The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minLength'/><text><p>If <tt>schema</tt> has the property <tt>"minLength"</tt>, then the    <tt>value</tt> must not be shorter than the specified length.</p>   </text></group><group><item name='maxLength'/><text><p>If <tt>schema</tt> has the property <tt>"maxLength"</tt>, then the    <tt>value</tt> must not be longer than the specified length.</p>   </text></group><group><item name='pattern'/><text><p>If <tt>schema</tt> has the property <tt>"pattern"</tt>, then the    <tt>value</tt> must match the specified pattern.</p>   </text></group></dl>   </text><group><note/><text><p>TODO: We use <ref resolved='predef::Regexp.SimpleRegexp'>Regexp.SimpleRegexp</ref> to handle <tt>schema-&gt;pattern</tt>,    but that covers only some part of the possible regular expressions.</p>   </text></group></doc>   <method name='validate_string'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   </class>   </module>   <module name='JSON5'>   <doc><text><p>Tools for handling the JSON5 structured data format. See    <url>http://www.json5.org/</url> and <rfc>4627</rfc>.</p>   </text></doc>   <docgroup homogen-type='constant'><doc><text><p>Bit field flags for use with <ref resolved='predef::Standards.JSON5.encode'>encode</ref>:</p>   <dl><group><item name='Standards.JSON5.ASCII_ONLY'/><text><p>Use <expr>\uxxxx</expr> escapes for all non-ascii characters and DEL
autodoc.git/autodoc.xml:125308:   <docgroup homogen-name='validate' homogen-type='method'><doc><text><p>This function validates a JSON5 object against the JSON5 schema that was    specified in the Validator's constructor.    If the JSON5 object is not valid, a string with an error-message is    returned.    If the JSON5 object is valid, 0 is returned.</p>   </text><group><param name='json5'/><text><p>The JSON5 object to validate.</p>   </text></group><group><returns/><text><p>0, if the json5 object is valid, and an error-message if it is not valid.</p>   </text></group></doc>   <method name='validate'>   <arguments><argument name='json5'><type><mixed/></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_array' homogen-type='method'><doc><text><p>Verify that the specified <tt>value</tt> is an array according to the    specified <tt>schema</tt>.    The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minItems'/><text><p>If <tt>schema</tt> has the property <tt>"minItems"</tt>, then the array must    have at least the specified number of items.</p>   </text></group><group><item name='maxItems'/><text><p>If <tt>schema</tt> has the property <tt>"maxItems"</tt>, then the array must    not have more than the specified number of items.</p>   </text></group><group><item name='items'/><text><p>If <tt>schema</tt> has the property <tt>"items"</tt>, which is an array of    schema objects, then each element in the value array must be valid    according the corresponding schema in the <tt>"items"</tt> array.</p>   </text></group></dl>   </text></doc>   <method name='validate_array'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_integer' homogen-type='method'><doc><text><p>Verify that the specified value is an integer according to the specified    <tt>schema</tt>. This is the similar to <ref resolved='predef::Standards.JSON5.Validator.validate_number'>validate_number()</ref>, but the    <tt>value</tt> must be an int and not a float.    The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minimum'/><text><p>If the <tt>schema</tt> has the property <tt>"minimum"</tt>, then the    <tt>value</tt> must be greater than or equal to the specified minimum.</p>   </text></group><group><item name='exclusiveMinimum'/><text><p>If the <tt>schema</tt> has the properties <tt>"minimum"</tt> and    <tt>"exclusiveMinimum"</tt> is <ref resolved='predef::Standards.JSON5.true'>Standards.JSON5.true</ref>, then the
autodoc.git/autodoc.xml:125348:    <tt>value</tt> must be lower than or equal to the specified maximum.</p>   </text></group><group><item name='exclusiveMaximum'/><text><p>If the <tt>schema</tt> has the properties <tt>"maximum"</tt> and    <tt>"exclusiveMaximum"</tt> is <ref resolved='predef::Standards.JSON5.true'>Standards.JSON5.true</ref>, then the    <tt>value</tt> must be lower than the specified minimum.</p>   </text></group><group><item name='multipleOf'/><text><p>If <tt>schema</tt> has the property <tt>"multipleOf"</tt>, then the    <tt>value</tt> must be an integer multiple of the specified multpleOf.</p>   </text></group></dl>   </text></doc>   <method name='validate_integer'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_item_type' homogen-type='method'><doc><text><p>Verify that the specified <tt>value</tt> has the correct type that is    defined by <tt>schema-&gt;type</tt>. <tt>schema-&gt;type</tt> can be any of</p>   <ul><group><item/><text><p>"boolean",</p>   </text></group><group><item/><text><p>"integer",</p>   </text></group><group><item/><text><p>"number",</p>   </text></group><group><item/><text><p>"string",</p>   </text></group><group><item/><text><p>"array",</p>   </text></group><group><item/><text><p>"object",</p>   </text></group><group><item/><text><p>"null",</p>   </text></group></ul><p>or an array of these.</p>   </text></doc>   <method name='validate_item_type'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping/></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_number' homogen-type='method'><doc><text><p>Verify that the specified value is a number (integer or float) according    to the specified <tt>schema</tt>.    The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minimum'/><text><p>If the <tt>schema</tt> has the property <tt>"minimum"</tt>, then the    <tt>value</tt> must be greater than or equal to the specified minimum.</p>   </text></group><group><item name='exclusiveMinimum'/><text><p>If the <tt>schema</tt> has the properties <tt>"minimum"</tt> and    <tt>"exclusiveMinimum"</tt> is <ref resolved='predef::Standards.JSON5.true'>Standards.JSON5.true</ref>, then the    <tt>value</tt> must be greater than the specified minimum.</p>
autodoc.git/autodoc.xml:125386:    <tt>value</tt> must be lower than or equal to the specified maximum.</p>   </text></group><group><item name='exclusiveMaximum'/><text><p>If the <tt>schema</tt> has the properties <tt>"maximum"</tt> and    <tt>"exclusiveMaximum"</tt> is <ref resolved='predef::Standards.JSON5.true'>Standards.JSON5.true</ref>, then the    <tt>value</tt> must be lower than the specified minimum.</p>   </text></group><group><item name='multipleOf'/><text><p>If <tt>schema</tt> has the property <tt>"multipleOf"</tt>, then the    <tt>value</tt> must be an integer multiple of the specified multpleOf.</p>   </text></group></dl>   </text></doc>   <method name='validate_number'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_object' homogen-type='method'><doc><text><p>Verify that the specified <tt>value</tt> is an object according to the    specified <tt>schema</tt>.    The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minProperties'/><text><p>If <tt>schema</tt> has the property <tt>"minProperties"</tt>, then the    object must have at least the specified number of properties.</p>   </text></group><group><item name='maxProperties'/><text><p>If <tt>schema</tt> has the property <tt>"maxProperties"</tt>, then the    object must not have more than the specified number of items.</p>   </text></group><group><item name='required'/><text><p>If <tt>schema</tt> has the property <tt>"required"</tt>, which is an array
autodoc.git/autodoc.xml:125424:   </text></group><group><item/><text><p>If it is a schema, then any propery of the object that is not    validated by a schema from <tt>"properties"</tt> or    <tt>"patternProperties"</tt> must be validated by the specified schema.</p>   </text></group></ul></text></group></dl>   </text><group><note/><text><p>TODO: We use <ref resolved='predef::Regexp.SimpleRegexp'>Regexp.SimpleRegexp</ref> to handle    <tt>schema-&gt;patternProperties</tt>, but that covers only some part of the    possible regular expressions.</p>   </text></group></doc>   <method name='validate_object'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_properties' homogen-type='method'><doc><text><p>Verify that the specified value matches the specified <tt>schema</tt>. The    following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='type'/><text><p>If the <tt>schema</tt> has a property <tt>"type"</tt>, then the <tt>value</tt>    must match the specified type (see <ref resolved='predef::Standards.JSON5.Validator.validate_item_type'>validate_item_type()</ref>).</p>   </text></group><group><item name='allOf'/><text><p>If the <tt>schema</tt> has a property <tt>"allOf"</tt>, which is an array of    schema objects, then the <tt>value</tt> must match each schema specified    in that array (via another call to <ref resolved='predef::Standards.JSON5.Validator.validate_properties'>validate_properties()</ref>).</p>   </text></group><group><item name='anyOf'/><text><p>If the <tt>schema</tt> has a property <tt>"anyOf"</tt>, which is an array of
autodoc.git/autodoc.xml:125453:    must not match the schema specified by that property (via another    call to <ref resolved='predef::Standards.JSON5.Validator.validate_properties'>validate_properties()</ref>).</p>   </text></group><group><item name='enum'/><text><p>If the <tt>schema</tt> has a property <tt>"enum"</tt>, then the <tt>value</tt>    must be equal to any of the values specified in the enum array.</p>   </text></group></dl>   </text><group><note/><text><p>If the <tt>schema</tt> is empty (i.e., it has none of the above specified    properties, then the <tt>value</tt> is valid).</p>   </text></group></doc>   <method name='validate_properties'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping/></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='validate_string' homogen-type='method'><doc><text><p>Verify that the specified value is a string according to the specified    <tt>schema</tt>. The following properties of <tt>schema</tt> are verified:</p>   <dl><group><item name='minLength'/><text><p>If <tt>schema</tt> has the property <tt>"minLength"</tt>, then the    <tt>value</tt> must not be shorter than the specified length.</p>   </text></group><group><item name='maxLength'/><text><p>If <tt>schema</tt> has the property <tt>"maxLength"</tt>, then the    <tt>value</tt> must not be longer than the specified length.</p>   </text></group><group><item name='pattern'/><text><p>If <tt>schema</tt> has the property <tt>"pattern"</tt>, then the    <tt>value</tt> must match the specified pattern.</p>   </text></group></dl>   </text><group><note/><text><p>TODO: We use <ref resolved='predef::Regexp.SimpleRegexp'>Regexp.SimpleRegexp</ref> to handle <tt>schema-&gt;pattern</tt>,    but that covers only some part of the possible regular expressions.</p>   </text></group></doc>   <method name='validate_string'><modifiers><private/></modifiers>   <arguments><argument name='key'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='schema'><type><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></type></argument></arguments> - <returntype><string/></returntype> + <returntype><or><string/><zero/></or></returntype>   </method>   </docgroup>   </class>   </module>   <module name='MsgPack'>   <doc><text><p>Tools for handling the MsgPack data format. MsgPack is a binary    serialization format with applications similar to JSON. However,    MsgPack is more versatile and is able to serialize arbitrary    objects using an extension format. The following table shows how    some special Pike data types are encoded in the MsgPack