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

#include <zipFile.h>

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 Iterator ()
 
USD_API ~Iterator ()
 
USD_API Iterator (const Iterator &rhs)
 
USD_API Iterator (Iterator &&rhs)
 
USD_API Iteratoroperator= (const Iterator &rhs)
 
USD_API Iteratoroperator= (Iterator &&rhs)
 
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
 
USD_API FileInfo GetFileInfo () const
 

Friends

class UsdZipFile
 

Detailed Description

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

Definition at line 115 of file zipFile.h.

Member Typedef Documentation

using UsdZipFile::Iterator::difference_type = std::ptrdiff_t

Definition at line 147 of file zipFile.h.

using UsdZipFile::Iterator::iterator_category = std::forward_iterator_tag

Definition at line 151 of file zipFile.h.

using UsdZipFile::Iterator::pointer = _ArrowProxy

Definition at line 149 of file zipFile.h.

Definition at line 150 of file zipFile.h.

Definition at line 148 of file zipFile.h.

Constructor & Destructor Documentation

USD_API UsdZipFile::Iterator::Iterator ( )
USD_API UsdZipFile::Iterator::~Iterator ( )
USD_API UsdZipFile::Iterator::Iterator ( const Iterator rhs)
USD_API UsdZipFile::Iterator::Iterator ( Iterator &&  rhs)

Member Function Documentation

USD_API const char* UsdZipFile::Iterator::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 UsdZipFile::Iterator::GetFileInfo ( ) const

Returns FileInfo object containing information about the current file.

USD_API reference UsdZipFile::Iterator::operator* ( ) const

Returns filename of the current file in the zip archive.

USD_API Iterator& UsdZipFile::Iterator::operator++ ( )
USD_API Iterator UsdZipFile::Iterator::operator++ ( int  )
USD_API pointer UsdZipFile::Iterator::operator-> ( ) const

Returns filename of the current file in the zip archive.

USD_API Iterator& UsdZipFile::Iterator::operator= ( const Iterator rhs)
USD_API Iterator& UsdZipFile::Iterator::operator= ( Iterator &&  rhs)
USD_API bool UsdZipFile::Iterator::operator== ( const Iterator rhs) const

Friends And Related Function Documentation

friend class UsdZipFile
friend

Definition at line 186 of file zipFile.h.


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