MutableData Struct Reference

#include <MutableData.h>

Overview

Mutable data buffers.

Definition at line 40 of file MutableData.h.

Inheritance diagram for MutableData:

Properties
Data	data
	The superclass. More...
Properties inherited from Data
uint8_t *	bytes
	The bytes. More...
DataDestructor	destroy
	An optional destructor that, if set, is called on dealloc. More...
size_t	length
	The length of bytes. More...
Object	object
	The superclass. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_MutableData (void)
	The MutableData archetype. More...
void	appendBytes (MutableData *self, const uint8_t *bytes, size_t length)
	Appends the given bytes to this Data. More...
void	appendData (MutableData *self, const Data *data)
	Appends the given data to this Data. More...
MutableData *	data (void)
	Returns a new MutableData. More...
MutableData *	dataWithCapacity (size_t capacity)
	Returns a new MutableData with the given capacity. More...
MutableData *	init (MutableData *self)
	Initializes this Data with length 0. More...
MutableData *	initWithCapacity (MutableData *self, size_t capacity)
	Initializes this Data with the given capacity. More...
MutableData *	initWithData (MutableData *self, const Data *data)
	Initializes this Data with the contents of data. More...
void	setLength (MutableData *self, size_t length)
	Sets the length of this Data, truncating or expanding it. More...
Methods inherited from Data
Class *	_Data (void)
	The Data archetype. More...
Data *	dataWithBytes (const uint8_t *bytes, size_t length)
	Returns a new Data by copying length of bytes. More...
Data *	dataWithConstMemory (const ident mem, size_t length)
	Returns a new Data, backed by the given const memory. More...
Data *	dataWithContentsOfFile (const char *path)
	Returns a new Data with the contents of the file at path. More...
Data *	dataWithMemory (ident mem, size_t length)
	Returns a new Data, taking ownership of the specified memory. More...
Data *	initWithBytes (Data *self, const uint8_t *bytes, size_t length)
	Initializes this Data by copying length of bytes. More...
Data *	initWithConstMemory (Data *self, const ident mem, size_t length)
	Initializes this Data with the given const memory. More...
Data *	initWithContentsOfFile (Data *self, const char *path)
	Initializes this Data with the contents of the file at path. More...
Data *	initWithMemory (Data *self, ident mem, size_t length)
	Initializes this Data, taking ownership of the specified memory. More...
MutableData *	mutableCopy (const Data *self)
_Bool	writeToFile (const Data *self, const char *path)
	Writes this Data to path. More...
Methods inherited from Object
Class *	_Object (void)
	The Object archetype. More...
Object *	copy (const Object *self)
	Creates a shallow copy of this Object. More...
void	dealloc (Object *self)
	Frees all resources held by this Object. More...
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object. More...
_Bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object. More...
_Bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership. More...

Protected Attributes
MutableDataInterface *	interface
	The interface. More...
Protected Attributes inherited from Data
DataInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

data

MutableData * data

(

void

)

The superclass.

Definition at line 45 of file MutableData.h.

interface

MutableDataInterface* MutableData::interface

protected

The interface.

Definition at line 51 of file MutableData.h.

Method Details

_MutableData()

Class * _MutableData

(

void

)

The MutableData archetype.

Returns

The MutableData Class.

Definition at line 182 of file MutableData.c.

                          {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "MutableData",
            .superclass = _Data(),
            .instanceSize = sizeof(MutableData),
            .interfaceOffset = offsetof(MutableData, interface),
            .interfaceSize = sizeof(MutableDataInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

appendBytes()

void appendBytes	(	MutableData *	self,
		const uint8_t *	bytes,
		size_t	length
	)

Appends the given bytes to this Data.

Parameters

self	The MutableData.
bytes	The bytes to append.
length	The length of bytes to append.

Remarks

MutableData are grown in blocks as bytes are appended. This provides a significant performance gain when frequently appending small chunks of bytes.

Definition at line 53 of file MutableData.c.

                                                                                {
 
    const size_t oldLength = self->data.length;
 
    $(self, setLength, self->data.length + length);
 
    memcpy(self->data.bytes + oldLength, bytes, length);
}

appendData()

void appendData	(	MutableData *	self,
		const Data *	data
	)

Appends the given data to this Data.

Parameters

self	The MutableData.
data	The Data to append.

Definition at line 66 of file MutableData.c.

                                                            {
 
    $(self, appendBytes, data->bytes, data->length);
}

data()

MutableData * data

(

void

)

Returns a new MutableData.

Returns

The new MutableData, or NULL on error.

Definition at line 75 of file MutableData.c.

                               {
 
    return $(alloc(MutableData), init);
}

dataWithCapacity()

MutableData * dataWithCapacity

(

size_t

capacity

)

Returns a new MutableData with the given capacity.

Parameters

capacity

The desired capacity in bytes.

Returns

The new MutableData, or NULL on error.

Definition at line 84 of file MutableData.c.

                                                      {
 
    return $(alloc(MutableData), initWithCapacity, capacity);
}

init()

MutableData * init

(

MutableData *

self

)

Initializes this Data with length 0.

Parameters

self	The MutableData.

Returns

The initialized Data, or NULL on error.

Definition at line 93 of file MutableData.c.

                                            {
 
    return $(self, initWithCapacity, 0);
}

initWithCapacity()

MutableData * initWithCapacity	(	MutableData *	self,
		size_t	capacity
	)

Initializes this Data with the given capacity.

Parameters

self	The MutableData.
capacity	The capacity in bytes.

Returns

The initialized Data, or NULL on error.

Definition at line 102 of file MutableData.c.

                                                                         {
 
    self = (MutableData *) super(Object, self, init);
    if (self) {
 
        self->capacity = capacity;
        if (self->capacity) {
 
            self->data.bytes = calloc(capacity, sizeof(uint8_t));
            assert(self->data.bytes);
        }
 
        self->data.destroy = free;
    }
 
    return self;
}

initWithData()

MutableData * initWithData	(	MutableData *	self,
		const Data *	data
	)

Initializes this Data with the contents of data.

Parameters

self	The MutableData.
data	A Data.

Returns

The initialized Data, or NULL on error.

Definition at line 124 of file MutableData.c.

                                                                      {
 
    self = $(self, initWithCapacity, data->length);
    if (self) {
        $(self, appendData, data);
    }
 
    return self;
}

setLength()

void setLength	(	MutableData *	self,
		size_t	length
	)

Sets the length of this Data, truncating or expanding it.

Parameters

self	The MutableData.
length	The new desired length.

Remarks

If the data is expanded, the newly allocated bytes are filled with zeros.

Definition at line 138 of file MutableData.c.

                                                        {
 
    const size_t newCapacity = (length / _pageSize + 1) * _pageSize;
    if (newCapacity > self->capacity) {
 
        if (self->data.bytes == NULL) {
            self->data.bytes = calloc(newCapacity, sizeof(uint8_t));
            assert(self->data.bytes);
        } else {
            self->data.bytes = realloc(self->data.bytes, newCapacity);
            assert(self->data.bytes);
 
            memset(self->data.bytes + self->data.length, 0, length - self->data.length);
        }
 
        self->capacity = newCapacity;
    }
 
    self->data.length = length;
}

---

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

• Sources/Objectively/MutableData.h
• Sources/Objectively/MutableData.c