|
ObjFW
|
A class for accessing and manipulating tar archives. More...
#import <ObjFW/OFTarArchive.h>
Instance Methods | |
| (instancetype) | - initWithStream:mode: |
| Initializes an already allocated OFTarArchive object with the specified stream. | |
| (instancetype) | - initWithIRI:mode: |
| Initializes an already allocated OFTarArchive object with the specified file. | |
| (nullable OFTarArchiveEntry *) | - nextEntry |
Returns the next entry from the tar archive or nil if all entries have been read. | |
| (OFStream *) | - streamForReadingCurrentEntry |
| Returns a stream for reading the current entry. | |
| (OFStream *) | - streamForWritingEntry: |
| Returns a stream for writing the specified entry. | |
| (void) | - close |
| Closes the OFTarArchive. | |
Instance Methods inherited from OFObject | |
| (instancetype) | - init |
| Initializes an already allocated object. | |
| (nullable OFMethodSignature *) | - methodSignatureForSelector: |
| Returns the method signature for the specified selector. | |
| (void) | - dealloc |
| Deallocates the object. | |
| (void) | - performSelector:afterDelay: |
| Performs the specified selector after the specified delay. | |
| (void) | - performSelector:withObject:afterDelay: |
| Performs the specified selector with the specified object after the specified delay. | |
| (void) | - performSelector:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:withObject:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:waitUntilDone: |
| Performs the specified selector on the specified thread. | |
| (void) | - performSelector:onThread:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified object. | |
| (void) | - performSelector:onThread:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the specified thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:waitUntilDone: |
| Performs the specified selector on the main thread. | |
| (void) | - performSelectorOnMainThread:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified object. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone: |
| Performs the specified selector on the main thread with the specified objects. | |
| (void) | - performSelector:onThread:afterDelay: |
| Performs the specified selector on the specified thread after the specified delay. | |
| (void) | - performSelector:onThread:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified object after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (void) | - performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay: |
| Performs the specified selector on the specified thread with the specified objects after the specified delay. | |
| (nullable id) | - forwardingTargetForSelector: |
| This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. | |
| (void) | - doesNotRecognizeSelector: |
| Handles messages which are not understood by the receiver. | |
Instance Methods inherited from <OFObject> | |
| (Class) | - class |
| Returns the class of the object. | |
| (nullable Class) | - superclass |
| Returns the superclass of the object. | |
| (unsigned long) | - hash |
| Returns a hash for the object. | |
| (unsigned int) | - retainCount |
| Returns the retain count. | |
| (bool) | - isProxy |
| Returns whether the object is a proxy object. | |
| (bool) | - isKindOfClass: |
| Returns a boolean whether the object is of the specified kind. | |
| (bool) | - isMemberOfClass: |
| Returns a boolean whether the object is a member of the specified class. | |
| (bool) | - respondsToSelector: |
| Returns a boolean whether the object responds to the specified selector. | |
| (bool) | - conformsToProtocol: |
| Checks whether the object conforms to the specified protocol. | |
| (nullable IMP) | - methodForSelector: |
| Returns the implementation for the specified selector. | |
| (nullable id) | - performSelector: |
| Performs the specified selector. | |
| (nullable id) | - performSelector:withObject: |
| Performs the specified selector with the specified object. | |
| (nullable id) | - performSelector:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (bool) | - isEqual: |
| Checks two objects for equality. | |
| (instancetype) | - retain |
| Increases the retain count. | |
| (void) | - release |
| Decreases the retain count. | |
| (instancetype) | - autorelease |
| Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. | |
| (instancetype) | - self |
| Returns the receiver. | |
| (bool) | - allowsWeakReference |
| Returns whether the object allows a weak reference. | |
| (bool) | - retainWeakReference |
| Retain a weak reference to this object. | |
Class Methods | |
| (instancetype) | + archiveWithStream:mode: |
| Creates a new OFTarArchive object with the specified stream. | |
| (instancetype) | + archiveWithIRI:mode: |
| Creates a new OFTarArchive object with the specified file. | |
| (OFIRI *) | + IRIForFilePath:inArchiveWithIRI: |
| Creates an IRI for accessing a the specified file within the specified tar archive. | |
Class Methods inherited from OFObject | |
| (void) | + load |
| A method which is called once when the class is loaded into the runtime. | |
| (void) | + unload |
| A method which is called when the class is unloaded from the runtime. | |
| (void) | + initialize |
| A method which is called the moment before the first call to the class is being made. | |
| (instancetype) | + alloc |
| Allocates memory for an instance of the class and sets up the memory pool for the object. | |
| (Class) | + class |
| Returns the class. | |
| (OFString *) | + className |
| Returns the name of the class as a string. | |
| (bool) | + isSubclassOfClass: |
| Returns a boolean whether the class is a subclass of the specified class. | |
| (nullable Class) | + superclass |
| Returns the superclass of the class. | |
| (bool) | + instancesRespondToSelector: |
| Checks whether instances of the class respond to a given selector. | |
| (bool) | + conformsToProtocol: |
| Checks whether the class conforms to a given protocol. | |
| (nullable IMP) | + instanceMethodForSelector: |
| Returns the implementation of the instance method for the specified selector. | |
| (nullable OFMethodSignature *) | + instanceMethodSignatureForSelector: |
| Returns the method signature of the instance method for the specified selector. | |
| (OFString *) | + description |
| Returns a description for the class, which is usually the class name. | |
| (nullable IMP) | + replaceClassMethod:withMethodFromClass: |
| Replaces a class method with a class method from another class. | |
| (nullable IMP) | + replaceInstanceMethod:withMethodFromClass: |
| Replaces an instance method with an instance method from another class. | |
| (void) | + inheritMethodsFromClass: |
| Adds all methods from the specified class to the class that is the receiver. | |
| (bool) | + resolveClassMethod: |
| Try to resolve the specified class method. | |
| (bool) | + resolveInstanceMethod: |
| Try to resolve the specified instance method. | |
| (id) | + copy |
| Returns the class. | |
Properties | |
| OFStringEncoding | encoding |
| The encoding to use for the archive. Defaults to UTF-8. | |
Properties inherited from OFObject | |
| OFString * | className |
| The name of the object's class. | |
| OFString * | description |
| A description for the object. | |
A class for accessing and manipulating tar archives.
Creates a new OFTarArchive object with the specified file.
| IRI | The IRI to the tar archive |
| mode | The mode for the tar file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive. |
| OFInvalidFormatException | The archive has an invalid format |
| OFSeekFailedException | The archive was open in append mode and seeking failed |
Creates a new OFTarArchive object with the specified stream.
| stream | A stream from which the tar archive will be read. For append mode, this needs to be an OFSeekableStream. |
| mode | The mode for the tar file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive. |
| OFInvalidFormatException | The archive has an invalid format |
| OFSeekFailedException | The archive was open in append mode and seeking failed |
| - (void) close |
Closes the OFTarArchive.
| OFNotOpenException | The archive is not open |
Initializes an already allocated OFTarArchive object with the specified file.
| IRI | The IRI to the tar archive |
| mode | The mode for the tar file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive. |
| OFInvalidFormatException | The archive has an invalid format |
| OFSeekFailedException | The archive was open in append mode and seeking failed |
Initializes an already allocated OFTarArchive object with the specified stream.
| stream | A stream from which the tar archive will be read. For append mode, this needs to be an OFSeekableStream. |
| mode | The mode for the tar file. Valid modes are "r" for reading, "w" for creating a new file and "a" for appending to an existing archive. |
| OFInvalidFormatException | The archive has an invalid format |
| OFSeekFailedException | The archive was open in append mode and seeking failed |
Creates an IRI for accessing a the specified file within the specified tar archive.
| path | The path of the file within the archive |
| IRI | The IRI of the archive |
| - (OFTarArchiveEntry *) nextEntry |
Returns the next entry from the tar archive or nil if all entries have been read.
nil if all entries have been read | OFInvalidFormatException | The archive has an invalid format |
| - (OFStream *) streamForReadingCurrentEntry |
Returns a stream for reading the current entry.
| - (OFStream *) streamForWritingEntry: | (OFTarArchiveEntry *) | entry |
Returns a stream for writing the specified entry.
| entry | The entry for which a stream for writing should be returned |