nntp.yenc
=========

.. py:module:: nntp.yenc

.. autoapi-nested-parse::

   Basic yEnc decoder.
   Copyright (C) 2013-2020  Byron Platt

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.



Classes
-------

.. autoapisummary::

   nntp.yenc.YEnc


Functions
---------

.. autoapisummary::

   nntp.yenc.trailer_crc32


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

.. py:function:: trailer_crc32(trailer: bytes) -> int | None

   Extract the CRC32 value from a yEnc trailer.


.. py:class:: YEnc

   A basic yEnc decoder.

   Keeps track of the CRC32 value as data is decoded.


   .. py:attribute:: crc32
      :value: 0



   .. py:attribute:: _escape
      :value: 0



   .. py:method:: decode(buf: bytes) -> bytes