class_marshalls.rst 5.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Marshalls.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Marshalls:
  6. Marshalls
  7. =========
  8. **Inherits:** :ref:`Object<class_Object>`
  9. Data transformation (marshalling) and encoding helpers.
  10. Description
  11. -----------
  12. Provides data transformation and encoding utility functions.
  13. Methods
  14. -------
  15. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`base64_to_raw<class_Marshalls_method_base64_to_raw>` **(** :ref:`String<class_String>` base64_str **)** |
  17. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`String<class_String>` | :ref:`base64_to_utf8<class_Marshalls_method_base64_to_utf8>` **(** :ref:`String<class_String>` base64_str **)** |
  19. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Variant<class_Variant>` | :ref:`base64_to_variant<class_Marshalls_method_base64_to_variant>` **(** :ref:`String<class_String>` base64_str, :ref:`bool<class_bool>` allow_objects=false **)** |
  21. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`String<class_String>` | :ref:`raw_to_base64<class_Marshalls_method_raw_to_base64>` **(** :ref:`PoolByteArray<class_PoolByteArray>` array **)** |
  23. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`String<class_String>` | :ref:`utf8_to_base64<class_Marshalls_method_utf8_to_base64>` **(** :ref:`String<class_String>` utf8_str **)** |
  25. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`String<class_String>` | :ref:`variant_to_base64<class_Marshalls_method_variant_to_base64>` **(** :ref:`Variant<class_Variant>` variant, :ref:`bool<class_bool>` full_objects=false **)** |
  27. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. Method Descriptions
  29. -------------------
  30. .. _class_Marshalls_method_base64_to_raw:
  31. - :ref:`PoolByteArray<class_PoolByteArray>` **base64_to_raw** **(** :ref:`String<class_String>` base64_str **)**
  32. Returns a decoded :ref:`PoolByteArray<class_PoolByteArray>` corresponding to the Base64-encoded string ``base64_str``.
  33. ----
  34. .. _class_Marshalls_method_base64_to_utf8:
  35. - :ref:`String<class_String>` **base64_to_utf8** **(** :ref:`String<class_String>` base64_str **)**
  36. Returns a decoded string corresponding to the Base64-encoded string ``base64_str``.
  37. ----
  38. .. _class_Marshalls_method_base64_to_variant:
  39. - :ref:`Variant<class_Variant>` **base64_to_variant** **(** :ref:`String<class_String>` base64_str, :ref:`bool<class_bool>` allow_objects=false **)**
  40. Returns a decoded :ref:`Variant<class_Variant>` corresponding to the Base64-encoded string ``base64_str``. If ``allow_objects`` is ``true``, decoding objects is allowed.
  41. **Warning:** Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
  42. ----
  43. .. _class_Marshalls_method_raw_to_base64:
  44. - :ref:`String<class_String>` **raw_to_base64** **(** :ref:`PoolByteArray<class_PoolByteArray>` array **)**
  45. Returns a Base64-encoded string of a given :ref:`PoolByteArray<class_PoolByteArray>`.
  46. ----
  47. .. _class_Marshalls_method_utf8_to_base64:
  48. - :ref:`String<class_String>` **utf8_to_base64** **(** :ref:`String<class_String>` utf8_str **)**
  49. Returns a Base64-encoded string of the UTF-8 string ``utf8_str``.
  50. ----
  51. .. _class_Marshalls_method_variant_to_base64:
  52. - :ref:`String<class_String>` **variant_to_base64** **(** :ref:`Variant<class_Variant>` variant, :ref:`bool<class_bool>` full_objects=false **)**
  53. Returns a Base64-encoded string of the :ref:`Variant<class_Variant>` ``variant``. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code).
  54. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  55. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  56. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`