:py:mod:`dissect.database.ese.util`
===================================

.. py:module:: dissect.database.ese.util




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.database.ese.util.ColumnType



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.database.ese.util.decode_bit
   dissect.database.ese.util.decode_text
   dissect.database.ese.util.decode_guid
   dissect.database.ese.util.checksum_xor



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.database.ese.util.CODEPAGE_MAP
   dissect.database.ese.util.RecordValue
   dissect.database.ese.util.COLUMN_TYPES
   dissect.database.ese.util.COLUMN_TYPE_MAP


.. py:data:: CODEPAGE_MAP

.. py:type:: RecordValue
   :canonical: int | float | str | bytes | datetime.datetime | None


.. py:function:: decode_bit(buf: bytes) -> bool

   Decode a bit into a boolean.

   :param buf: The buffer to decode from.


.. py:function:: decode_text(buf: bytes, encoding: dissect.database.ese.c_ese.CODEPAGE, errors: str | None = 'backslashreplace') -> str

   Decode text with the appropriate encoding.

   :param buf: The buffer to decode from.


.. py:function:: decode_guid(buf: bytes) -> str

   Decode a GUID.

   :param buf: The buffer to decode from.


.. py:function:: checksum_xor(data: bytes, initial: int = 2309737967) -> int

.. py:class:: ColumnType

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: value
      :type:  dissect.database.ese.c_ese.JET_coltyp


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: size
      :type:  int | None


   .. py:attribute:: parse
      :type:  collections.abc.Callable[[bytes], Any] | None


.. py:data:: COLUMN_TYPES

.. py:data:: COLUMN_TYPE_MAP