A class for storing arbitrary data in an array. More...

#import <ObjFW/OFDataArray.h>

Inheritance diagram for OFDataArray:

Instance Methods
(id)	- initWithItemSize:
	Initializes an already allocated OFDataArray whose items all have the same size. More...

(id)	- initWithCapacity:
	Initializes an already allocated OFDataArray with enough memory to hold the specified number of items which all have an item size of 1. More...

(id)	- initWithItemSize:capacity:
	Initializes an already allocated OFDataArray with enough memory to hold the specified number of items which all have the same specified size. More...

(id)	- initWithContentsOfFile:
	Initializes an already allocated OFDataArray with an item size of 1, containing the data of the specified file. More...

(id)	- initWithContentsOfURL:
	Initializes an already allocated OFDataArray with an item size of 1, containing the data of the specified URL. More...

(id)	- initWithStringRepresentation:
	Initializes an already allocated OFDataArray with an item size of 1, containing the data of the string representation. More...

(id)	- initWithBase64EncodedString:
	Initializes an already allocated OFDataArray with an item size of 1, containing the data of the Base64-encoded string. More...

(size_t)	- count
	Returns the number of items in the OFDataArray. More...

(size_t)	- itemSize
	Returns the size of a single item in the OFDataArray in bytes. More...

(void *)	- items
	Returns all items of the OFDataArray as a C array. More...

(void *)	- itemAtIndex:
	Returns a specific item of the OFDataArray. More...

(nullable void *)	- firstItem
	Returns the first item of the OFDataArray. More...

(nullable void *)	- lastItem
	Returns the last item of the OFDataArray. More...

(void)	- addItem:
	Adds an item to the OFDataArray. More...

(void)	- insertItem:atIndex:
	Adds an item to the OFDataArray at the specified index. More...

(void)	- addItems:count:
	Adds items from a C array to the OFDataArray. More...

(void)	- insertItems:atIndex:count:
	Adds items from a C array to the OFDataArray at the specified index. More...

(void)	- removeItemAtIndex:
	Removes the item at the specified index. More...

(void)	- removeItemsInRange:
	Removes the specified amount of items at the specified index. More...

(void)	- removeLastItem
	Removes the last item.

(void)	- removeAllItems
	Removes all items.

(OFString *)	- stringRepresentation
	Returns the string representation of the data array. More...

(OFString *)	- stringByBase64Encoding
	Returns a string containing the data in Base64 encoding. More...

(void)	- writeToFile:
	Writes the OFDataArray into the specified file. More...

(OFString *)	- MD5Hash
	Returns the MD5 hash of the data array as an autoreleased OFString. More...

(OFString *)	- RIPEMD160Hash
	Returns the RIPEMD-160 hash of the data array as an autoreleased OFString. More...

(OFString *)	- SHA1Hash
	Returns the SHA-1 hash of the data array as an autoreleased OFString. More...

(OFString *)	- SHA224Hash
	Returns the SHA-224 hash of the data array as an autoreleased OFString. More...

(OFString *)	- SHA256Hash
	Returns the SHA-256 hash of the data array as an autoreleased OFString. More...

(OFString *)	- SHA384Hash
	Returns the SHA-384 hash of the data array as an autoreleased OFString. More...

(OFString *)	- SHA512Hash
	Returns the SHA-512 hash of the data array as an autoreleased OFString. More...

(id)	- messagePackValue
	Parses the MessagePack representation and returns it as an object. More...

Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object. More...

(OFString *)	- className
	Returns the name of the object's class. More...

(OFString *)	- description
	Returns a description for the object. More...

(void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...

(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool. More...

(nullable void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size. More...

(nullable void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size. More...

(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool. More...

(void)	- dealloc
	Deallocates the object. More...

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay. More...

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay. More...

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread. More...

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object. More...

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread. More...

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object. More...

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay. More...

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay. More...

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...

(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. More...

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver. More...

(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver. More...

Instance Methods inherited from <OFObject>
(bool)	- isKindOfClass:
	Returns a boolean whether the object of the specified kind. More...

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class. More...

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector. More...

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector. More...

(nullable const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector. More...

(nullable id)	- performSelector:
	Performs the specified selector. More...

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object. More...

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects. More...

(bool)	- isEqual:
	Checks two objects for equality. More...

(uint32_t)	- hash
	Calculates a hash for the object. More...

(id)	- retain
	Increases the retain count. More...

(unsigned int)	- retainCount
	Returns the retain count. More...

(void)	- release
	Decreases the retain count. More...

(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...

(id)	- self
	Returns the receiver. More...

(bool)	- isProxy
	Returns whether the object is a proxy object. More...

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object. More...

Instance Methods inherited from <OFComparing>
(of_comparison_result_t)	- compare:
	Compares the object with another object. More...

Instance Methods inherited from <OFSerialization>
(id)	- initWithSerialization:
	Initializes the object with the specified XML element serialization. More...

(OFXMLElement *)	- XMLElementBySerializing
	Serializes the object into an XML element. More...

Instance Methods inherited from <OFMessagePackRepresentation>
(OFDataArray *)	- messagePackRepresentation
	Returns the MessagePack representation of the object as an OFDataArray. More...

Class Methods
(instancetype)	+ dataArray
	Creates a new OFDataArray with an item size of 1. More...

(instancetype)	+ dataArrayWithItemSize:
	Creates a new OFDataArray whose items all have the same specified size. More...

(instancetype)	+ dataArrayWithCapacity:
	Creates a new OFDataArray with enough memory to hold the specified number of items which all have an item size of 1. More...

(instancetype)	+ dataArrayWithItemSize:capacity:
	Creates a new OFDataArray with enough memory to hold the specified number of items which all have the same specified size. More...

(instancetype)	+ dataArrayWithContentsOfFile:
	Creates a new OFDataArary with an item size of 1, containing the data of the specified file. More...

(instancetype)	+ dataArrayWithContentsOfURL:
	Creates a new OFDataArray with an item size of 1, containing the data of the specified URL. More...

(instancetype)	+ dataArrayWithStringRepresentation:
	Creates a new OFDataArray with an item size of 1, containing the data of the string representation. More...

(instancetype)	+ dataArrayWithBase64EncodedString:
	Creates a new OFDataArray with an item size of 1, containing the data of the Base64-encoded string. More...

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime. More...

(void)	+ unload
	A method which is called when the class is unloaded from the runtime. More...

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made. More...

(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object. More...

(id)	+ new
	Allocates memory for a new instance and calls init on it. More...

(Class)	+ class
	Returns the class. More...

(OFString *)	+ className
	Returns the name of the class as a string. More...

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class. More...

(Class)	+ superclass
	Returns the superclass of the class. More...

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector. More...

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol. More...

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector. More...

(nullable const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector. More...

(OFString *)	+ description
	Returns a description for the class, which is usually the class name. More...

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class. More...

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class. More...

(nullable IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method. More...

(nullable IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method. More...

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver. More...

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method. More...

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method. More...

(id)	+ copy
	Returns the class. More...

Detailed Description

A class for storing arbitrary data in an array.

If you plan to store large hunks of data, you should consider using OFBigDataArray, which allocates the memory in pages rather than in bytes.

For security reasons, serialization and deserialization is only implemented for OFDataArrays with item size 1.

Method Documentation

- (void) addItem: (const void*) item

Adds an item to the OFDataArray.

Parameters

item	A pointer to an arbitrary item

- (void) addItems:	(const void*)	items
count:	(size_t)	count

Adds items from a C array to the OFDataArray.

Parameters

items	A C array containing the items to add
count	The number of items to add

- (size_t) count

Returns the number of items in the OFDataArray.

Returns: The number of items in the OFDataArray

+ (instancetype) dataArray

Creates a new OFDataArray with an item size of 1.

Returns: A new autoreleased OFDataArray

+ (instancetype) dataArrayWithBase64EncodedString: (OFString*) string

Creates a new OFDataArray with an item size of 1, containing the data of the Base64-encoded string.

Parameters

string The string with the Base64-encoded data

Returns: A new autoreleased OFDataArray

+ (instancetype) dataArrayWithCapacity: (size_t) capacity

Creates a new OFDataArray with enough memory to hold the specified number of items which all have an item size of 1.

Parameters

capacity The initial capacity for the OFDataArray

Returns: A new autoreleased OFDataArray

+ (instancetype) dataArrayWithContentsOfFile: (OFString*) path

Creates a new OFDataArary with an item size of 1, containing the data of the specified file.

Parameters

path	The path of the file

Returns: A new autoreleased OFDataArray

+ (instancetype) dataArrayWithContentsOfURL: (OFURL*) URL

Creates a new OFDataArray with an item size of 1, containing the data of the specified URL.

Parameters

URL	The URL to the contents for the OFDataArray

Returns: A new autoreleased OFDataArray

+ (instancetype) dataArrayWithItemSize: (size_t) itemSize

Creates a new OFDataArray whose items all have the same specified size.

Parameters

itemSize The size of a single element in the OFDataArray

Returns: A new autoreleased OFDataArray

+ (instancetype) dataArrayWithItemSize:	(size_t)	itemSize
capacity:	(size_t)	capacity

Creates a new OFDataArray with enough memory to hold the specified number of items which all have the same specified size.

Parameters

itemSize	The size of a single element in the OFDataArray
capacity	The initial capacity for the OFDataArray

Returns: A new autoreleased OFDataArray

+ (instancetype) dataArrayWithStringRepresentation: (OFString*) string

Creates a new OFDataArray with an item size of 1, containing the data of the string representation.

Parameters

string The string representation of the data

Returns: A new autoreleased OFDataArray

- (void *) firstItem

Returns the first item of the OFDataArray.

Returns: The first item of the OFDataArray or NULL

- (id) initWithBase64EncodedString: (OFString*) string

Initializes an already allocated OFDataArray with an item size of 1, containing the data of the Base64-encoded string.

Parameters

string The string with the Base64-encoded data

Returns: An initialized OFDataArray

- (id) initWithCapacity: (size_t) capacity

Initializes an already allocated OFDataArray with enough memory to hold the specified number of items which all have an item size of 1.

Parameters

capacity The initial capacity for the OFDataArray

Returns: An initialized OFDataArray

- (id) initWithContentsOfFile: (OFString*) path

Initializes an already allocated OFDataArray with an item size of 1, containing the data of the specified file.

Parameters

path	The path of the file

Returns: An initialized OFDataArray

- (id) initWithContentsOfURL: (OFURL*) URL

Initializes an already allocated OFDataArray with an item size of 1, containing the data of the specified URL.

Parameters

URL	The URL to the contents for the OFDataArray

Returns: A new autoreleased OFDataArray

- (id) initWithItemSize: (size_t) itemSize

Initializes an already allocated OFDataArray whose items all have the same size.

Parameters

itemSize The size of a single element in the OFDataArray

Returns: An initialized OFDataArray

- (id) initWithItemSize:	(size_t)	itemSize
capacity:	(size_t)	capacity

Initializes an already allocated OFDataArray with enough memory to hold the specified number of items which all have the same specified size.

Parameters

itemSize	The size of a single element in the OFDataArray
capacity	The initial capacity for the OFDataArray

Returns: An initialized OFDataArray

- (id) initWithStringRepresentation: (OFString*) string

Initializes an already allocated OFDataArray with an item size of 1, containing the data of the string representation.

Parameters

string The string representation of the data

Returns: A new autoreleased OFDataArray

- (void) insertItem:	(const void*)	item
atIndex:	(size_t)	index

Adds an item to the OFDataArray at the specified index.

Parameters

item	A pointer to an arbitrary item
index	The index where the item should be added

- (void) insertItems:	(const void*)	items
atIndex:	(size_t)	index
count:	(size_t)	count

Adds items from a C array to the OFDataArray at the specified index.

Parameters

items	A C array containing the items to add
index	The index where the items should be added
count	The number of items to add

- (void *) itemAtIndex: (size_t) index

Returns a specific item of the OFDataArray.

Parameters

index The number of the item to return

Returns: The specified item of the OFDataArray

- (void*) items

Returns all items of the OFDataArray as a C array.

Warning: The pointer is only valid until the OFDataArray is changed!

Modifying the returned array directly is allowed and will change the contents of the data array.

Returns: All elements of the OFDataArray as a C array

- (size_t) itemSize

Returns the size of a single item in the OFDataArray in bytes.

Returns: The size of a single item in the OFDataArray in bytes

- (void *) lastItem

Returns the last item of the OFDataArray.

Returns: The last item of the OFDataArray or NULL

- (OFString *) MD5Hash

Returns the MD5 hash of the data array as an autoreleased OFString.

Returns: The MD5 hash of the data array as an autoreleased OFString

- (id) messagePackValue

Parses the MessagePack representation and returns it as an object.

Returns: The MessagePack representation as an object

- (void) removeItemAtIndex: (size_t) index

Removes the item at the specified index.

Parameters

index The index of the item to remove

- (void) removeItemsInRange: (of_range_t) range

Removes the specified amount of items at the specified index.

Parameters

range The range of items to remove

- (OFString *) RIPEMD160Hash

Returns the RIPEMD-160 hash of the data array as an autoreleased OFString.

Returns: The RIPEMD-160 hash of the data array as an autoreleased OFString

- (OFString *) SHA1Hash

Returns the SHA-1 hash of the data array as an autoreleased OFString.

Returns: The SHA-1 hash of the data array as an autoreleased OFString

- (OFString *) SHA224Hash

Returns the SHA-224 hash of the data array as an autoreleased OFString.

Returns: The SHA-224 hash of the data array as an autoreleased OFString

- (OFString *) SHA256Hash

Returns the SHA-256 hash of the data array as an autoreleased OFString.

Returns: The SHA-256 hash of the data array as an autoreleased OFString

- (OFString *) SHA384Hash

Returns the SHA-384 hash of the data array as an autoreleased OFString.

Returns: The SHA-384 hash of the data array as an autoreleased OFString

- (OFString *) SHA512Hash

Returns the SHA-512 hash of the data array as an autoreleased OFString.

Returns: The SHA-512 hash of the data array as an autoreleased OFString

- (OFString *) stringByBase64Encoding

Returns a string containing the data in Base64 encoding.

Returns: A string containing the data in Base64 encoding

- (OFString *) stringRepresentation

Returns the string representation of the data array.

The string representation is a hex dump of the data inside the data array, grouped by itemSize bytes.

Returns: The string representation of the data array.

- (void) writeToFile: (OFString*) path

Writes the OFDataArray into the specified file.

Parameters

path	The path of the file to write to

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

src/OFDataArray.h
src/OFDataArray.m

Instance Methods

Class Methods

Detailed Description

Method Documentation