general_superstaq.serialization
===============================

.. py:module:: general_superstaq.serialization


Functions
---------

.. autoapisummary::

   general_superstaq.serialization.bytes_to_str
   general_superstaq.serialization.deserialize
   general_superstaq.serialization.serialize
   general_superstaq.serialization.str_to_bytes


Module Contents
---------------

.. py:function:: bytes_to_str(bytes_data: bytes) -> str

   Convert arbitrary bytes data into a string.

   :param bytes_data: The data to be converted.

   :returns: The string from conversion.


.. py:function:: deserialize(serialized_obj: str) -> Any

   Deserialize serialized objects.

   :param serialized_obj: A string generated via `general_superstaq.serialization.serialize`.

   :returns: The serialized object.


.. py:function:: serialize(obj: Any) -> str

   Serialize picklable object into a string.

   :param obj: A picklable object to be serialized.

   :returns: The string representing the serialized object.


.. py:function:: str_to_bytes(str_data: str) -> bytes

   Decode the string-encoded bytes data returned by `bytes_to_str`.

   :param str_data: The string data to be decoded.

   :returns: The decoded by bytes data.