ZZArchiveEntry Class Reference
| Inherits from | NSObject |
| Declared in | ZZArchiveEntry.h |
Overview
The ZZArchiveEntry class represents an entry in the ZZArchive or ZZMutableArchive zip file.
Tasks
-
compressedproperty -
lastModifiedproperty -
crc32property -
compressedSizeproperty -
uncompressedSizeproperty -
fileModeproperty -
fileNameproperty -
+ archiveEntryWithFileName:compress:streamBlock: -
+ archiveEntryWithFileName:compress:dataBlock: -
+ archiveEntryWithFileName:compress:dataConsumerBlock: -
+ archiveEntryWithDirectoryName: -
+ archiveEntryWithFileName:fileMode:lastModified:compressionLevel:dataBlock:streamBlock:dataConsumerBlock: -
– check: -
– newStream -
– newData -
– newDataProvider
Properties
compressed
Whether the entry is compressed.
@property (readonly, nonatomic) BOOL compressedDeclared In
ZZArchiveEntry.hcompressedSize
The compressed size of the entry file: 0 for new entries.
@property (readonly, nonatomic) NSUInteger compressedSizeDeclared In
ZZArchiveEntry.hcrc32
The CRC32 code of the entry file: 0 for new entries.
@property (readonly, nonatomic) NSUInteger crc32Declared In
ZZArchiveEntry.hfileMode
The UNIX file mode for the entry: 0 for new or non-UNIX entries. This includes the file type bits.
@property (readonly, nonatomic) mode_t fileModeDeclared In
ZZArchiveEntry.hfileName
The file name of the entry.
@property (readonly, nonatomic) NSString *fileNameDeclared In
ZZArchiveEntry.hlastModified
The last modified date and time of the entry. The time value is only accurate to 2 seconds.
@property (readonly, nonatomic) NSDate *lastModifiedDeclared In
ZZArchiveEntry.huncompressedSize
The uncompressed size of the entry file: 0 for new entries.
@property (readonly, nonatomic) NSUInteger uncompressedSizeDeclared In
ZZArchiveEntry.hClass Methods
archiveEntryWithDirectoryName:
Creates a new directory entry.
+ (instancetype)archiveEntryWithDirectoryName:(NSString *)directoryNameParameters
- directoryName
The directory name for the entry.
Return Value
The created entry.
Declared In
ZZArchiveEntry.harchiveEntryWithFileName:compress:dataBlock:
Creates a new file entry from a data callback.
+ (instancetype)archiveEntryWithFileName:(NSString *)fileName compress:(BOOL)compress dataBlock:(NSData *( ^ ) ( NSError **error ))dataBlockParameters
- fileName
The file name for the entry.
- compress
Whether to compress the entry.
- dataBlock
The callback to return the entry’s data. Returns nil if the write was considered unsuccessful.
Return Value
The created entry.
Declared In
ZZArchiveEntry.harchiveEntryWithFileName:compress:dataConsumerBlock:
Creates a new file entry from a data-consuming callback.
+ (instancetype)archiveEntryWithFileName:(NSString *)fileName compress:(BOOL)compress dataConsumerBlock:(BOOL ( ^ ) ( CGDataConsumerRef dataConsumer , NSError **error ))dataConsumerBlockParameters
- fileName
The file name for the entry.
- compress
Whether to compress the entry.
- dataConsumerBlock
The callback to put the entry’s data into the data consumer. Returns whether the write was considered successful.
Return Value
The created entry.
Declared In
ZZArchiveEntry.harchiveEntryWithFileName:compress:streamBlock:
Creates a new file entry from a streaming callback.
+ (instancetype)archiveEntryWithFileName:(NSString *)fileName compress:(BOOL)compress streamBlock:(BOOL ( ^ ) ( NSOutputStream *stream , NSError **error ))streamBlockParameters
- fileName
The file name for the entry.
- compress
Whether to compress the entry.
- streamBlock
The callback to write the entry’s data to the stream. Returns whether the write was considered successful.
Return Value
The created entry.
Declared In
ZZArchiveEntry.harchiveEntryWithFileName:fileMode:lastModified:compressionLevel:dataBlock:streamBlock:dataConsumerBlock:
Creates a new entry.
+ (instancetype)archiveEntryWithFileName:(NSString *)fileName fileMode:(mode_t)fileMode lastModified:(NSDate *)lastModified compressionLevel:(NSInteger)compressionLevel dataBlock:(NSData *( ^ ) ( NSError **error ))dataBlock streamBlock:(BOOL ( ^ ) ( NSOutputStream *stream , NSError **error ))streamBlock dataConsumerBlock:(BOOL ( ^ ) ( CGDataConsumerRef dataConsumer , NSError **error ))dataConsumerBlockParameters
- fileName
The file name for the entry.
- fileMode
The UNIX file mode for the entry. This includes the file type bits.
- lastModified
The last modified date and time for the entry. The time value is only accurate to 2 seconds.
- compressionLevel
The compression level for the entry: 0 for stored, -1 for default deflate, 1 - 9 for custom deflate levels.
- dataBlock
The callback that returns the entry file data. Returns nil if the write was considered unsuccessful.
- streamBlock
The callback that writes the entry file to the stream. Returns whether the write was considered successful.
- dataConsumerBlock
The callback that writes the entry file to the data consumer. Returns whether the write was considered successful.
Return Value
The created entry.
Discussion
The archive entry will choose the first non-nil dataBlock, streamBlock and dataConsumerBlock to supply its data.
Declared In
ZZArchiveEntry.hInstance Methods
check:
Checks whether the entry file is consistent.
- (BOOL)check:(NSError **)errorParameters
- error
The error information when an error occurs. Pass in nil if you do not want error information.
Return Value
Whether entry file is consistent or not.
Discussion
Checks whether the local file entry is consistent with the central file entry and also that the recorded and actual checksums of the data agree.
Declared In
ZZArchiveEntry.hnewData
Creates data to represent the entry file.
- (NSData *)newDataReturn Value
The new data: nil for new entries.
Declared In
ZZArchiveEntry.h