doc/api.rst

   1
   2 rarfile API documentation
   3 =========================
   4
   5 .. contents:: Table Of Contents
   6
   7 Introduction
   8 ------------
   9
  10 .. automodule:: rarfile
  11
  12 RarFile class
  13 -------------
  14
  15 .. autoclass:: RarFile
  16    :members:
  17    :special-members: __enter__, __exit__, __iter__
  18
  19 RarInfo class
  20 -------------
  21
  22 .. autoclass:: RarInfo
  23    :members:
  24
  25 RarExtFile class
  26 ----------------
  27
  28 .. autoclass:: RarExtFile
  29    :show-inheritance:
  30    :members:
  31    :inherited-members:
  32    :exclude-members: truncate, flush
  33
  34 nsdatetime class
  35 ----------------
  36
  37 .. autoclass:: nsdatetime
  38    :show-inheritance:
  39    :members:
  40
  41 Functions
  42 ---------
  43
  44 .. autofunction:: is_rarfile
  45 .. autofunction:: is_rarfile_sfx
  46
  47 Constants
  48 ---------
  49
  50 .. autodata:: RAR_M0
  51 .. autodata:: RAR_M1
  52 .. autodata:: RAR_M2
  53 .. autodata:: RAR_M3
  54 .. autodata:: RAR_M4
  55 .. autodata:: RAR_M5
  56
  57 .. autodata:: RAR_OS_WIN32
  58 .. autodata:: RAR_OS_UNIX
  59 .. autodata:: RAR_OS_MACOS
  60 .. autodata:: RAR_OS_BEOS
  61 .. autodata:: RAR_OS_OS2
  62 .. autodata:: RAR_OS_MSDOS
  63
  64 Warnings
  65 --------
  66
  67 .. autoclass:: UnsupportedWarning
  68
  69 Exceptions
  70 ----------
  71
  72 .. autoclass:: Error
  73 .. autoclass:: BadRarFile
  74 .. autoclass:: NotRarFile
  75 .. autoclass:: BadRarName
  76 .. autoclass:: NoRarEntry
  77 .. autoclass:: PasswordRequired
  78 .. autoclass:: NeedFirstVolume
  79 .. autoclass:: NoCrypto
  80 .. autoclass:: RarExecError
  81 .. autoclass:: RarWarning
  82 .. autoclass:: RarFatalError
  83 .. autoclass:: RarCRCError
  84 .. autoclass:: RarLockedArchiveError
  85 .. autoclass:: RarWriteError
  86 .. autoclass:: RarOpenError
  87 .. autoclass:: RarUserError
  88 .. autoclass:: RarMemoryError
  89 .. autoclass:: RarCreateError
  90 .. autoclass:: RarNoFilesError
  91 .. autoclass:: RarUserBreak
  92 .. autoclass:: RarWrongPassword
  93 .. autoclass:: RarUnknownError
  94 .. autoclass:: RarSignalExit
  95 .. autoclass:: RarCannotExec
  96
  97