juce::ZipFile::ZipInputStream Struct Reference

Inheritance diagram for juce::ZipFile::ZipInputStream:

Public Member Functions
	ZipInputStream (ZipFile &zf, const ZipFile::ZipEntryHolder &zei)
	~ZipInputStream () override
int64	getTotalLength () override
int	read (void *buffer, int howMany) override
bool	isExhausted () override
int64	getPosition () override
bool	setPosition (int64 newPos) override
Public Member Functions inherited from juce::InputStream
virtual	~InputStream ()=default
int64	getNumBytesRemaining ()
ssize_t	read (void *destBuffer, size_t maxBytesToRead)
virtual char	readByte ()
virtual bool	readBool ()
virtual short	readShort ()
virtual short	readShortBigEndian ()
virtual int	readInt ()
virtual int	readIntBigEndian ()
virtual int64	readInt64 ()
virtual int64	readInt64BigEndian ()
virtual float	readFloat ()
virtual float	readFloatBigEndian ()
virtual double	readDouble ()
virtual double	readDoubleBigEndian ()
virtual int	readCompressedInt ()
virtual String	readNextLine ()
virtual String	readString ()
virtual String	readEntireStreamAsString ()
virtual size_t	readIntoMemoryBlock (MemoryBlock &destBlock, ssize_t maxNumBytesToRead=-1)
virtual void	skipNextBytes (int64 numBytesToSkip)

Private Attributes
ZipFile &	file
ZipEntryHolder	zipEntryHolder
int64	pos = 0
int	headerSize = 0
InputStream *	inputStream
std::unique_ptr< InputStream >	streamToDelete

Additional Inherited Members
Protected Member Functions inherited from juce::InputStream
	InputStream ()=default

Constructor & Destructor Documentation

ZipInputStream()

juce::ZipFile::ZipInputStream::ZipInputStream ( ZipFile & zf, const ZipFile::ZipEntryHolder & zei )

inline

~ZipInputStream()

juce::ZipFile::ZipInputStream::~ZipInputStream ( )

inlineoverride

Member Function Documentation

getPosition()

int64 juce::ZipFile::ZipInputStream::getPosition ( )

inlineoverridevirtual

Returns the offset of the next byte that will be read from the stream.

See also

setPosition

Implements juce::InputStream.

getTotalLength()

int64 juce::ZipFile::ZipInputStream::getTotalLength ( )

inlineoverridevirtual

Returns the total number of bytes available for reading in this stream.

Note that this is the number of bytes available from the start of the stream, not from the current position.

If the size of the stream isn't actually known, this will return -1.

See also

getNumBytesRemaining

Implements juce::InputStream.

isExhausted()

bool juce::ZipFile::ZipInputStream::isExhausted ( )

inlineoverridevirtual

Returns true if the stream has no more data to read.

Implements juce::InputStream.

read()

int juce::ZipFile::ZipInputStream::read ( void * destBuffer, int maxBytesToRead )

inlineoverridevirtual

Reads some data from the stream into a memory buffer.

This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).

Parameters

destBuffer	the destination buffer for the data. This must not be null.
maxBytesToRead	the maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative.

Returns

the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far

Implements juce::InputStream.

setPosition()

bool juce::ZipFile::ZipInputStream::setPosition ( int64 newPosition )

inlineoverridevirtual

Tries to move the current read position of the stream.

The position is an absolute number of bytes from the stream's start.

Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.

Returns

true if the stream manages to reposition itself correctly

See also

getPosition

Implements juce::InputStream.

Member Data Documentation

file

ZipFile& juce::ZipFile::ZipInputStream::file

private

headerSize

int juce::ZipFile::ZipInputStream::headerSize = 0

private

inputStream

InputStream* juce::ZipFile::ZipInputStream::inputStream

private

pos

int64 juce::ZipFile::ZipInputStream::pos = 0

private

streamToDelete

std::unique_ptr<InputStream> juce::ZipFile::ZipInputStream::streamToDelete

private

zipEntryHolder

ZipEntryHolder juce::ZipFile::ZipInputStream::zipEntryHolder

private

---

The documentation for this struct was generated from the following file:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/zip/juce_ZipFile.cpp