.. _api:

The API documentation
=================================

.. module:: trsfile

This part of the documentation covers all the interfaces of trsfile.

Overview
--------

.. autofunction:: open

.. autofunction:: create

.. autofunction:: trs_open

.. autofunction:: trs_create

.. automodule:: trsfile
    :members:
    :show-inheritance:


Helper classes and enumerates
-----------------------------

.. automodule:: trsfile.common
    :members:
    :undoc-members:
    :show-inheritance:


Trace class
-----------

.. automodule:: trsfile.trace
    :members:
    :undoc-members:
    :show-inheritance:


TrsFile class
-------------

.. automodule:: trsfile.trsfile
    :members:
    :undoc-members:
    :show-inheritance:


TrsFileMutable class
--------------------

.. automodule:: trsfile.trsfile_mutable
    :members:
    :undoc-members:
    :show-inheritance: