Data Struct Reference

#include <Data.h>

Overview

Immutable data buffers.

Definition at line 50 of file Data.h.

Inheritance diagram for Data:

Properties
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 *	_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
DataInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

bytes

uint8_t* Data::bytes

The bytes.

Definition at line 66 of file Data.h.

destroy

DataDestructor Data::destroy

An optional destructor that, if set, is called on dealloc.

Definition at line 71 of file Data.h.

interface

DataInterface* Data::interface

protected

The interface.

Definition at line 61 of file Data.h.

length

size_t Data::length

The length of bytes.

Definition at line 76 of file Data.h.

object

Object Data::object

The superclass.

Definition at line 55 of file Data.h.

Method Details

_Data()

Class * _Data

(

void

)

The Data archetype.

Returns

The Data Class.

Definition at line 283 of file Data.c.

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

dataWithBytes()

Data * dataWithBytes	(	const uint8_t *	bytes,
		size_t	length
	)

Returns a new Data by copying length of bytes.

Parameters

bytes	The bytes.
length	The length of bytes to copy.

Returns

The new Data, or NULL on error.

Definition at line 109 of file Data.c.

                                                                {
 
    return $(alloc(Data), initWithBytes, bytes, length);
}

dataWithConstMemory()

Data * dataWithConstMemory	(	const ident	mem,
		size_t	length
	)

Returns a new Data, backed by the given const memory.

Parameters

mem	The constant memory to back this Data.
length	The length of mem in bytes.

Returns

The new Data, or NULL on error.

Definition at line 118 of file Data.c.

                                                                 {
 
    return $(alloc(Data), initWithConstMemory, mem, length);
}

dataWithContentsOfFile()

Data * dataWithContentsOfFile

(

const char *

path

)

Returns a new Data with the contents of the file at path.

Parameters

path	The path of the file to read into memory.

Returns

The new Data, or NULL on error.

Definition at line 127 of file Data.c.

                                                      {
 
    return $(alloc(Data), initWithContentsOfFile, path);
}

dataWithMemory()

Data * dataWithMemory	(	ident	mem,
		size_t	length
	)

Returns a new Data, taking ownership of the specified memory.

Parameters

mem	The dynamically allocated memory to back this Data.
length	The length of mem in bytes.

Returns

The new Data, or NULL on error.

Definition at line 136 of file Data.c.

                                                      {
 
    return $(alloc(Data), initWithMemory, mem, length);
}

initWithBytes()

Data * initWithBytes	(	Data *	self,
		const uint8_t *	bytes,
		size_t	length
	)

Initializes this Data by copying length of bytes.

Parameters

self	The Data.
bytes	The bytes.
length	The length of bytes to copy.

Returns

The initialized Data, or NULL on error.

Definition at line 145 of file Data.c.

                                                                            {
 
    ident mem = malloc(length);
    assert(mem);
 
    memcpy(mem, bytes, length);
 
    return $(self, initWithMemory, mem, length);
}

initWithConstMemory()

Data * initWithConstMemory	(	Data *	self,
		const ident	mem,
		size_t	length
	)

Initializes this Data with the given const memory.

Parameters

self	The Data.
mem	The const memory to back this Data.
length	The length of mem in bytes.

Returns

The initialized Data, or NULL on error.

Definition at line 159 of file Data.c.

                                                                             {
 
    self = (Data *) super(Object, self, init);
    if (self) {
        self->bytes = mem;
        self->length = length;
    }
 
    return self;
}

initWithContentsOfFile()

Data * initWithContentsOfFile	(	Data *	self,
		const char *	path
	)

Initializes this Data with the contents of the file at path.

Parameters

self	The Data.
path	The path of the file to read into memory.

Returns

The initialized Data, or NULL on error.

Definition at line 174 of file Data.c.

                                                                  {
 
    assert(path);
 
    FILE *file = fopen(path, "rb");
    if (file) {
        ident mem = NULL;
 
        int err = fseek(file, 0, SEEK_END);
        assert(err == 0);
 
        const size_t length = ftell(file);
        if (length) {
 
            mem = malloc(length);
            assert(mem);
 
            err = fseek(file, 0, SEEK_SET);
            assert(err == 0);
 
            const size_t read = fread(mem, length, 1, file);
            assert(read == 1);
        }
 
        fclose(file);
        return $(self, initWithMemory, mem, length);
    }
 
    return release(self);
}

initWithMemory()

Data * initWithMemory	(	Data *	self,
		ident	mem,
		size_t	length
	)

Initializes this Data, taking ownership of the specified memory.

Parameters

self	The Data.
mem	The dynamically allocated memory to back this Data.
length	The length of mem in bytes.

Returns

The initialized Data, or NULL on error.

Definition at line 209 of file Data.c.

                                                                  {
 
    self = $(self, initWithConstMemory, mem, length);
    if (self) {
        self->destroy = free;
    }
 
    return self;
}

mutableCopy()

MutableData * mutableCopy

(

const Data *

self

)

Parameters

self

The Data.

Returns

A MutableData with the contents of this Data.

Definition at line 223 of file Data.c.

                                                  {
 
    return $(alloc(MutableData), initWithData, self);
}

writeToFile()

_Bool writeToFile	(	const Data *	self,
		const char *	path
	)

Writes this Data to path.

Parameters

self	The Data.
path	The path of the file to write.

Returns

true on success, false on error.

Definition at line 232 of file Data.c.

                                                             {
 
    assert(path);
 
    FILE *file = fopen(path, "w");
    if (file) {
 
        size_t count = 1;
 
        if (self->length) {
            count = fwrite(self->bytes, self->length, 1, file);
        }
 
        fclose(file);
 
        if (count == 1) {
            return true;
        }
    }
 
    return false;
}

---

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

• Sources/Objectively/Data.h
• Sources/Objectively/Data.c