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

#import <ObjFW/OFData.h>

Inheritance diagram for OFData:

Instance Methods
(id)	- initWithItems:count:
	Initialized an already allocated OFData with the specified `count` items of size 1. More...

(id)	- initWithItems:itemSize:count:
	Initialized an already allocated OFData with the specified `count` items of the specified size. More...

(id)	- initWithItemsNoCopy:count:freeWhenDone:
	Initializes an already allocated OFData with the specified `count` items of size 1 by taking over ownership of the specified items pointer. More...

(id)	- initWithItemsNoCopy:itemSize:count:freeWhenDone:
	Initializes an already allocated OFData with the specified `count` items of the specified size by taking ownership of the specified items pointer. More...

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

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

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

(id)	- initWithBase64EncodedString:
	Initializes an already allocated OFData 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 OFData. More...

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

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

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

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

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

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

(void)	- writeToFile:
	Writes the OFData 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...

(id)	- messagePackValueWithDepthLimit:
	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...

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

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

(bool)	- allowsWeakReference
	Returns whether the class allows weak references. More...

(bool)	- retainWeakReference
	Retain a weak reference to this object. More...

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

Instance Methods inherited from <OFMutableCopying>
(id)	- mutableCopy
	Creates a mutable copy of the 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>
(OFData *)	- messagePackRepresentation
	Returns the MessagePack representation of the object as OFData. More...

Class Methods
(instancetype)	+ dataWithItems:count:
	Creates a new OFData with the specified `count` items of size 1. More...

(instancetype)	+ dataWithItems:itemSize:count:
	Creates a new OFData with the specified `count` items of the specified size. More...

(instancetype)	+ dataWithItemsNoCopy:count:freeWhenDone:
	Creates a new OFData with the specified `count` items of size 1 by taking over ownership of the specified items pointer. More...

(instancetype)	+ dataWithItemsNoCopy:itemSize:count:freeWhenDone:
	Creates a new OFData with the specified `count` items of the specified size by taking ownership of the specified items pointer. More...

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

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

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

(instancetype)	+ dataWithBase64EncodedString:
	Creates a new OFData 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...

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

Properties
size_t	itemSize

Detailed Description

A class for storing arbitrary data in an array.

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

Method Documentation

◆ count()

- (size_t) count

Returns the number of items in the OFData.

Returns: The number of items in the OFData

◆ dataWithBase64EncodedString:()

+ (instancetype) dataWithBase64EncodedString: (OFString *) string

Creates a new OFData 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 OFData

◆ dataWithContentsOfFile:()

+ (instancetype) dataWithContentsOfFile: (OFString *) path

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

Parameters

path	The path of the file

Returns: A new autoreleased OFData

◆ dataWithContentsOfURL:()

+ (instancetype) dataWithContentsOfURL: (OFURL *) URL

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

Parameters

URL	The URL to the contents for the OFData

Returns: A new autoreleased OFData

◆ dataWithItems:count:()

+ (instancetype) dataWithItems:	(const void *)	items
count:	(size_t)	count

Creates a new OFData with the specified count items of size 1.

Parameters

items	The items to store in the OFData
count	The number of items

Returns: A new autoreleased OFData

◆ dataWithItems:itemSize:count:()

+ (instancetype) dataWithItems:	(const void *)	items
itemSize:	(size_t)	itemSize
count:	(size_t)	count

Creates a new OFData with the specified count items of the specified size.

Parameters

items	The items to store in the OFData
itemSize	The item size of a single item in bytes
count	The number of items

Returns: A new autoreleased OFData

◆ dataWithItemsNoCopy:count:freeWhenDone:()

+ (instancetype) dataWithItemsNoCopy:	(const void *)	items
count:	(size_t)	count
freeWhenDone:	(bool)	freeWhenDone

Creates a new OFData with the specified count items of size 1 by taking over ownership of the specified items pointer.

Parameters

items	The items to store in the OFData
count	The number of items
freeWhenDone	Whether to free the pointer when it is no longer needed by the OFData

Returns: A new autoreleased OFData

Reimplemented in OFMutableData.

◆ dataWithItemsNoCopy:itemSize:count:freeWhenDone:()

+ (instancetype) dataWithItemsNoCopy:	(const void *)	items
itemSize:	(size_t)	itemSize
count:	(size_t)	count
freeWhenDone:	(bool)	freeWhenDone

Creates a new OFData with the specified count items of the specified size by taking ownership of the specified items pointer.

Parameters

items	The items to store in the OFData
itemSize	The item size of a single item in bytes
count	The number of items
freeWhenDone	Whether to free the pointer when it is no longer needed by the OFData

Returns: A new autoreleased OFData

Reimplemented in OFMutableData.

◆ dataWithStringRepresentation:()

+ (instancetype) dataWithStringRepresentation: (OFString *) string

Creates a new OFData 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 OFData

◆ firstItem()

- (const void *) firstItem

Returns the first item of the OFData.

Returns: The first item of the OFData or NULL

Reimplemented in OFMutableData.

◆ initWithBase64EncodedString:()

- (id) initWithBase64EncodedString: (OFString *) string

Initializes an already allocated OFData 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 OFData

◆ initWithContentsOfFile:()

- (id) initWithContentsOfFile: (OFString *) path

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

Parameters

path	The path of the file

Returns: An initialized OFData

◆ initWithContentsOfURL:()

- (id) initWithContentsOfURL: (OFURL *) URL

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

Parameters

URL	The URL to the contents for the OFData

Returns: A new autoreleased OFData

◆ initWithItems:count:()

- (id) initWithItems:	(const void *)	items
count:	(size_t)	count

Initialized an already allocated OFData with the specified count items of size 1.

Parameters

items	The items to store in the OFData
count	The number of items

Returns: An initialized OFData

◆ initWithItems:itemSize:count:()

- (id) initWithItems:	(const void *)	items
itemSize:	(size_t)	itemSize
count:	(size_t)	count

Initialized an already allocated OFData with the specified count items of the specified size.

Parameters

items	The items to store in the OFData
itemSize	The item size of a single item in bytes
count	The number of items

Returns: An initialized OFData

◆ initWithItemsNoCopy:count:freeWhenDone:()

- (id) initWithItemsNoCopy:	(const void *)	items
count:	(size_t)	count
freeWhenDone:	(bool)	freeWhenDone

Initializes an already allocated OFData with the specified count items of size 1 by taking over ownership of the specified items pointer.

Parameters

items	The items to store in the OFData
count	The number of items
freeWhenDone	Whether to free the pointer when it is no longer needed by the OFData

Returns: An initialized OFData

Reimplemented in OFMutableData.

◆ initWithItemsNoCopy:itemSize:count:freeWhenDone:()

- (id) initWithItemsNoCopy:	(const void *)	items
itemSize:	(size_t)	itemSize
count:	(size_t)	count
freeWhenDone:	(bool)	freeWhenDone

Initializes an already allocated OFData with the specified count items of the specified size by taking ownership of the specified items pointer.

Parameters

items	The items to store in the OFData
itemSize	The item size of a single item in bytes
count	The number of items
freeWhenDone	Whether to free the pointer when it is no longer needed by the OFData

Returns: An initialized OFData

Reimplemented in OFMutableData.

◆ initWithStringRepresentation:()

- (id) initWithStringRepresentation: (OFString *) string

Initializes an already allocated OFData 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 OFData

◆ itemAtIndex:()

- (const void *) itemAtIndex: (size_t) index

Returns a specific item of the OFData.

Parameters

index The number of the item to return

Returns: The specified item of the OFData

Reimplemented in OFMutableData.

◆ items()

- (const void *) items

Returns all items of the OFData as a C array.

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

Returns: All elements of the OFData as a C array

Reimplemented in OFMutableData.

◆ lastItem()

- (const void *) lastItem

Returns the last item of the OFData.

Returns: The last item of the OFData or NULL

Reimplemented in OFMutableData.

◆ MD5Hash()

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

◆ messagePackValue()

- (id) messagePackValue

Parses the MessagePack representation and returns it as an object.

Returns: The MessagePack representation as an object

◆ messagePackValueWithDepthLimit:()

- (id) messagePackValueWithDepthLimit: (size_t) depthLimit

Parses the MessagePack representation and returns it as an object.

Parameters

depthLimit The maximum depth the parser should accept (defaults to 32 if not specified, 0 means no limit (insecure!))

Returns: The MessagePack representation as an object

◆ RIPEMD160Hash()

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

◆ SHA1Hash()

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

◆ SHA224Hash()

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

◆ SHA256Hash()

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

◆ SHA384Hash()

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

◆ SHA512Hash()

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

◆ stringByBase64Encoding()

- (OFString *) stringByBase64Encoding

Returns a string containing the data in Base64 encoding.

Returns: A string containing the data in Base64 encoding

◆ stringRepresentation()

- (OFString *) stringRepresentation

Returns the string representation of the data.

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

Returns: The string representation of the data.

◆ writeToFile:()

- (void) writeToFile: (OFString *) path

Writes the OFData into the specified file.

Parameters

path	The path of the file to write to

Property Documentation

◆ itemSize

- (size_t) itemSize

readnonatomicassign

The size of a single item in the OFData in bytes.

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

src/OFData.h
src/OFData.m

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ count()

◆ dataWithBase64EncodedString:()

◆ dataWithContentsOfFile:()

◆ dataWithContentsOfURL:()

◆ dataWithItems:count:()

◆ dataWithItems:itemSize:count:()

◆ dataWithItemsNoCopy:count:freeWhenDone:()

◆ dataWithItemsNoCopy:itemSize:count:freeWhenDone:()

◆ dataWithStringRepresentation:()

◆ firstItem()

◆ initWithBase64EncodedString:()

◆ initWithContentsOfFile:()

◆ initWithContentsOfURL:()

◆ initWithItems:count:()

◆ initWithItems:itemSize:count:()

◆ initWithItemsNoCopy:count:freeWhenDone:()

◆ initWithItemsNoCopy:itemSize:count:freeWhenDone:()

◆ initWithStringRepresentation:()

◆ itemAtIndex:()

◆ items()

◆ lastItem()

◆ MD5Hash()

◆ messagePackValue()

◆ messagePackValueWithDepthLimit:()

◆ RIPEMD160Hash()

◆ SHA1Hash()

◆ SHA224Hash()

◆ SHA256Hash()

◆ SHA384Hash()

◆ SHA512Hash()

◆ stringByBase64Encoding()

◆ stringRepresentation()

◆ writeToFile:()

Property Documentation

◆ itemSize