Error Struct Reference

#include <Error.h>

Overview

Encapsulation for error conditions.

Definition at line 41 of file Error.h.

Inheritance diagram for Error:

Properties
int	code
	The error code.
String *	domain
	The error domain.
String *	message
	The error message.
Object	object
	The superclass.
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class.
unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_Error (void)
	The Error archetype.
Error *	initWithDomain (Error *self, String *domain, int code, String *message)
	Initializes an Error with the given details.
Methods inherited from Object
Class *	_Object (void)
	The Object archetype.
Object *	copy (const Object *self)
	Creates a shallow copy of this Object.
void	dealloc (Object *self)
	Frees all resources held by this Object.
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object.
bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object.
bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership.

Protected Attributes
ErrorInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

code

int Error::code

The error code.

Definition at line 57 of file Error.h.

domain

String* Error::domain

The error domain.

Definition at line 62 of file Error.h.

interface

ErrorInterface* Error::interface

protected

The interface.

Definition at line 52 of file Error.h.

message

String* Error::message

The error message.

Definition at line 67 of file Error.h.

object

Object Error::object

The superclass.

Definition at line 46 of file Error.h.

Method Details

_Error()

Class * _Error

(

void

)

The Error archetype.

Returns

The Error Class.

Definition at line 166 of file Error.c.

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

initWithDomain()

Error * initWithDomain	(	Error *	self,
		String *	domain,
		int	code,
		String *	message
	)

Initializes an Error with the given details.

Parameters

self	The Error.
domain	The Error domain (required).
code	The error code.
message	The error message.

Returns

The initialized Error, or NULL on error.

Definition at line 128 of file Error.c.

                                                                                     {
 
  assert(domain);
 
  self = (Error *) super(Object, self, init);
  if (self) {
 
    self->domain = retain(domain);
    self->code = code;
 
    if (message) {
      self->message = retain(message);
    }
  }
 
  return self;
}

---

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

• Sources/Objectively/Error.h
• Sources/Objectively/Error.c