| Version: 3.2.8

Public Member Functions | List of all members
wxLZMAInputStream Class Reference
Class List by Category » Archive support | Class List by Category » Streams

`#include <wx/lzmastream.h>`

Inheritance diagram for wxLZMAInputStream:
[legend]

## Detailed Description

This filter stream decompresses data in XZ format.

XZ format uses LZMA2 algorithm for compression used for .xz files and is similar to GZip or BZip2 format. Notice that it is different from, and incompatible with, 7z archive format even although it uses the same compression algorithm.

To decompress contents of standard input to standard output, the following (not optimally efficient) code could be used:

wxFFileInputStream fin(stdin);
wxLZMAInputStream zin(fin);
wxFFileOutputStream fout(stdout);
zin.Read(fout);
if ( zin.GetLastError() != wxSTREAM_EOF ) {
... handle error ...
}
wxFFileInputStream
This class represents data read in from a file.
Definition: wfstream.h:284
wxFFileOutputStream
This class represents data written to a file.
Definition: wfstream.h:118
wxLZMAInputStream
This filter stream decompresses data in XZ format.
Definition: lzmastream.h:44
wxSTREAM_EOF
@ wxSTREAM_EOF
EOF reached in Read() or similar.
Definition: stream.h:16

See Using LZMA compression with liblzma for information about liblzma, required in order to use this class.

##

Library: wxBase
Category: Archive support, Streams

See also
  wxInputStream, wxZlibInputStream, wxLZMAOutputStream.

Since
  3.1.2

## Public Member Functions
| wxLZMAInputStream (wxInputStream &stream)
| Create decompressing stream associated with the given underlying stream. More...
| wxLZMAInputStream (wxInputStream *stream)
| Create decompressing stream associated with the given underlying stream and takes ownership of it. More...
Public Member Functions inherited from wxFilterInputStream
| wxFilterInputStream (wxInputStream &stream)
| Initializes a "filter" stream. More...
| wxFilterInputStream (wxInputStream *stream)
| Initializes a "filter" stream. More...
Public Member Functions inherited from wxInputStream
| wxInputStream ()
| Creates a dummy input stream. More...
virtual | ~wxInputStream ()
| Destructor. More...
virtual bool | CanRead () const
| Returns true if some data is available in the stream right now, so that calling Read() wouldn't block. More...
virtual bool | Eof () const
| Returns true after an attempt has been made to read past the end of the stream. More...
int | GetC ()
| Returns the first character in the input queue and removes it, blocking until it appears if necessary. More...
virtual size_t | LastRead () const
| Returns the last number of bytes read. More...
virtual char | Peek ()
| Returns the first character in the input queue without removing it. More...
virtual wxInputStream & | Read (void *buffer, size_t size)
| Reads the specified amount of bytes and stores the data in buffer. More...
wxInputStream & | Read (wxOutputStream &stream_out)
| Reads data from the input queue and stores it in the specified output stream. More...
bool | ReadAll (void *buffer, size_t size)
| Reads exactly the specified number of bytes into the buffer. More...
virtual wxFileOffset | SeekI (wxFileOffset pos, wxSeekMode mode=wxFromStart)
| Changes the stream current position. More...
virtual wxFileOffset | TellI () const
| Returns the current stream position or wxInvalidOffset if it's not available (e.g. More...
size_t | Ungetch (const void *buffer, size_t size)
| This function is only useful in read mode. More...
bool | Ungetch (char c)
| This function acts like the previous one except that it takes only one character: it is sometimes shorter to use than the generic function. More...
Public Member Functions inherited from wxStreamBase
| wxStreamBase ()
| Creates a dummy stream object. More...
virtual | ~wxStreamBase ()
| Destructor. More...
wxStreamError | GetLastError () const
| This function returns the last error. More...
virtual wxFileOffset | GetLength () const
| Returns the length of the stream in bytes. More...
virtual size_t | GetSize () const
| This function returns the size of the stream. More...
virtual bool | IsOk () const
| Returns true if no error occurred on the stream. More...
virtual bool | IsSeekable () const
| Returns true if the stream supports seeking to arbitrary offsets. More...
void | Reset (wxStreamError error=wxSTREAM_NO_ERROR)
| Resets the stream state. More...
bool | operator! () const
| Returns the opposite of IsOk(). More...

## Additional Inherited Members
Protected Member Functions inherited from wxInputStream
size_t | OnSysRead (void *buffer, size_t bufsize)=0
| Internal function. More...
Protected Member Functions inherited from wxStreamBase
virtual wxFileOffset | OnSysSeek (wxFileOffset pos, wxSeekMode mode)
| Internal function. More...
virtual wxFileOffset | OnSysTell () const
| Internal function. More...

## Constructor & Destructor Documentation

## ◆ wxLZMAInputStream() [1/2]

wxLZMAInputStream::wxLZMAInputStream | ( | wxInputStream & | stream | ) |

Create decompressing stream associated with the given underlying stream.

This overload does not take ownership of the stream.

## ◆ wxLZMAInputStream() [2/2]

wxLZMAInputStream::wxLZMAInputStream | ( | wxInputStream * | stream | ) |

Create decompressing stream associated with the given underlying stream and takes ownership of it.

As with the base wxFilterInputStream class, passing stream by pointer indicates that this object takes ownership of it and will delete it when it is itself destroyed.