ObjFW
OFTarArchive.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
3  * Jonathan Schleifer <js@heap.zone>
4  *
5  * All rights reserved.
6  *
7  * This file is part of ObjFW. It may be distributed under the terms of the
8  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
9  * the packaging of this file.
10  *
11  * Alternatively, it may be distributed under the terms of the GNU General
12  * Public License, either version 2 or 3, which can be found in the file
13  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
14  * file.
15  */
16 
17 #import "OFObject.h"
18 #import "OFTarArchiveEntry.h"
19 
20 OF_ASSUME_NONNULL_BEGIN
21 
22 @class OFString;
23 @class OFStream;
24 
31 {
32 #ifdef OF_TAR_ARCHIVE_ENTRY_M
33 @public
34 #endif
35  OFStream *_stream;
36 @protected
37  OFTarArchiveEntry *_Nullable _lastReturnedEntry;
38 }
39 
46 + (instancetype)archiveWithStream: (OFStream *)stream;
47 
48 #ifdef OF_HAVE_FILES
49 
55 + (instancetype)archiveWithPath: (OFString *)path;
56 #endif
57 
65 - initWithStream: (OFStream *)stream OF_DESIGNATED_INITIALIZER;
66 
67 #ifdef OF_HAVE_FILES
68 
75 - initWithPath: (OFString *)path;
76 #endif
77 
89 - (nullable OFTarArchiveEntry *)nextEntry;
90 @end
91 
92 OF_ASSUME_NONNULL_END
nullable OFTarArchiveEntry * nextEntry()
Returns the next entry from the tar archive or nil if all entries have been read. ...
Definition: OFTarArchive.m:74
A class for handling strings.
Definition: OFString.h:114
A class which represents an entry of a tar archive.
Definition: OFTarArchiveEntry.h:51
The root class for all other classes inside ObjFW.
Definition: OFObject.h:379
A class for accessing and manipulating tar archives.
Definition: OFTarArchive.h:30
A base class for different types of streams.
Definition: OFStream.h:88