2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 11:32:53 +02:00
<class name= "Marshalls" inherits= "Reference" category= "Core" version= "3.1.2" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-09-13 00:18:26 +02:00
Data transformation (marshalling) and encoding helpers.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-09-13 00:18:26 +02:00
Provides data transformation and encoding utility functions.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "base64_to_raw" >
<return type= "PoolByteArray" >
</return>
<argument index= "0" name= "base64_str" type= "String" >
</argument>
<description >
Return [PoolByteArray] of a given base64 encoded String.
</description>
</method>
<method name= "base64_to_utf8" >
<return type= "String" >
</return>
<argument index= "0" name= "base64_str" type= "String" >
</argument>
<description >
Return utf8 String of a given base64 encoded String.
</description>
</method>
<method name= "base64_to_variant" >
<return type= "Variant" >
</return>
<argument index= "0" name= "base64_str" type= "String" >
</argument>
2019-03-26 16:52:42 +01:00
<argument index= "1" name= "allow_objects" type= "bool" default= "false" >
</argument>
2017-09-12 22:42:36 +02:00
<description >
2019-03-26 16:52:42 +01:00
Return [Variant] of a given base64 encoded String. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed.
[b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "raw_to_base64" >
<return type= "String" >
</return>
<argument index= "0" name= "array" type= "PoolByteArray" >
</argument>
<description >
Return base64 encoded String of a given [PoolByteArray].
</description>
</method>
<method name= "utf8_to_base64" >
<return type= "String" >
</return>
<argument index= "0" name= "utf8_str" type= "String" >
</argument>
<description >
Return base64 encoded String of a given utf8 String.
</description>
</method>
<method name= "variant_to_base64" >
<return type= "String" >
</return>
<argument index= "0" name= "variant" type= "Variant" >
</argument>
2019-03-26 16:52:42 +01:00
<argument index= "1" name= "full_objects" type= "bool" default= "false" >
</argument>
2017-09-12 22:42:36 +02:00
<description >
2019-03-26 16:52:42 +01:00
Return base64 encoded String of a given [Variant]. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code).
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<constants >
</constants>
</class>