All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdZipFile::Iterator Class Reference

Iterator for traversing and inspecting the contents of the zip archive. More...

Public Types

using difference_type = std::ptrdiff_t
 
using value_type = std::string
 
using pointer = _ArrowProxy
 
using reference = std::string
 
using iterator_category = std::forward_iterator_tag
 

Public Member Functions

USD_API Iteratoroperator++ ()
 
USD_API Iterator operator++ (int)
 
USD_API bool operator== (const Iterator &rhs) const
 
USD_API bool operator!= (const Iterator &rhs) const
 
USD_API reference operator* () const
 Returns filename of the current file in the zip archive. More...
 
USD_API pointer operator-> () const
 Returns filename of the current file in the zip archive. More...
 
USD_API const char * GetFile () const
 Returns pointer to the beginning of the current file in the zip archive. More...
 
USD_API FileInfo GetFileInfo () const
 Returns FileInfo object containing information about the current file. More...
 

Friends

class UsdZipFile
 

Detailed Description

Iterator for traversing and inspecting the contents of the zip archive.

Definition at line 112 of file zipFile.h.

Member Function Documentation

USD_API const char* GetFile ( ) const

Returns pointer to the beginning of the current file in the zip archive.

The contents of the current file span the range [GetFile(), GetFile() + GetFileInfo().size).

Note that this points to the raw data stored in the zip archive; no decompression or other transformation is applied.

USD_API FileInfo GetFileInfo ( ) const

Returns FileInfo object containing information about the current file.

USD_API reference operator* ( ) const

Returns filename of the current file in the zip archive.

USD_API pointer operator-> ( ) const

Returns filename of the current file in the zip archive.


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