Crate objc_sys

Expand description

Raw bindings to Objective-C runtimes

These bindings contain almost no documentation, so it is highly recommended to read the documentation of the original libraries:

Apple’s official documentation.
Apple’s objc4 source code, in particular runtime.h.
GNUStep’s libobjc2 source code, in particular runtime.h.

See also the README.md for more background information, and for how to configure the desired runtime.

Structs

objc_class

An opaque type that represents an Objective-C class.

objc_ivar

An opaque type that represents an instance variable.

objc_method

A type that represents a method in a class definition.

objc_method_description

Describes an Objective-C method.

objc_object

An opaque type that represents an object / an instance of a class.

objc_property

An opaque type that describes a property in a class.

objc_property_attribute_t

Describes an Objective-C property attribute.

objc_protocol

Opaque type for Objective-C protocols.

objc_selector

An opaque type that represents a method selector.

objc_super

Specifies data used when sending messages to superclasses.

Constants

NO

The equivalent of false for Objective-C’s BOOL type.

NSIntegerMax

The maximum value for an NSInteger.

NSIntegerMin

The minimum value for an NSInteger.

NSUIntegerMax

The maximum value for an NSUInteger.

Nil

A quick alias for a null_mut class.

OBJC_ASSOCIATION_ASSIGN

OBJC_ASSOCIATION_COPY

OBJC_ASSOCIATION_COPY_NONATOMIC

OBJC_ASSOCIATION_RETAIN

OBJC_ASSOCIATION_RETAIN_NONATOMIC

OBJC_SYNC_NOT_INITIALIZEDapple

Only relevant before macOS 10.13

OBJC_SYNC_NOT_OWNING_THREAD_ERRORapple

OBJC_SYNC_SUCCESSapple

OBJC_SYNC_TIMED_OUTapple

Only relevant before macOS 10.13

YES

The equivalent of true for Objective-C’s BOOL type.

nil

A quick alias for a null_mut object / instance.

Functions

_objc_msgForward^⚠apple

_objc_msgForward_stret^⚠apple and non-AArch64

class_addIvar^⚠Non-objfw

class_addMethod^⚠

class_addProperty^⚠Non-objfw

class_addProtocol^⚠Non-objfw

class_conformsToProtocol^⚠

class_copyIvarList^⚠Non-objfw

class_copyMethodList^⚠Non-objfw

class_copyPropertyList^⚠Non-objfw

class_copyProtocolList^⚠Non-objfw

class_createInstance^⚠Non-objfw

class_getClassMethod^⚠Non-objfw

class_getClassVariable^⚠Non-objfw

class_getImageName^⚠apple

class_getInstanceMethod^⚠Non-objfw

class_getInstanceSize^⚠

class_getInstanceVariable^⚠Non-objfw

class_getIvarLayout^⚠Non-objfw

class_getMethodImplementation^⚠

class_getMethodImplementation_stret^⚠objfw or non-AArch64

class_getName^⚠

class_getProperty^⚠Non-objfw

class_getSuperclass^⚠

class_getVersion^⚠Non-objfw

class_getWeakIvarLayout^⚠apple

class_isMetaClass^⚠

class_replaceMethod^⚠

class_replaceProperty^⚠Non-objfw

class_respondsToSelector^⚠

class_setIvarLayout^⚠Non-objfw

class_setVersion^⚠Non-objfw

class_setWeakIvarLayout^⚠apple

imp_getBlock^⚠Non-objfw

imp_implementationWithBlock^⚠Non-objfw

imp_removeBlock^⚠Non-objfw

ivar_getName^⚠Non-objfw

ivar_getOffset^⚠Non-objfw

ivar_getTypeEncoding^⚠Non-objfw

method_copyArgumentType^⚠Non-objfw

method_copyReturnType^⚠Non-objfw

method_exchangeImplementations^⚠Non-objfw

method_getArgumentType^⚠Non-objfw

method_getDescription^⚠apple

method_getImplementation^⚠Non-objfw

method_getName^⚠Non-objfw

method_getNumberOfArguments^⚠Non-objfw

method_getReturnType^⚠Non-objfw

method_getTypeEncoding^⚠Non-objfw

method_invoke^⚠apple

method_invoke_stret^⚠apple and non-AArch64

method_setImplementation^⚠Non-objfw

objc_addExceptionHandler^⚠apple_new and macOS

objc_allocateClassPair^⚠

objc_allocateProtocol^⚠Non-objfw

objc_autorelease^⚠

objc_autoreleasePoolPop^⚠Non-objfw

objc_autoreleasePoolPush^⚠Non-objfw

objc_autoreleaseReturnValue^⚠

objc_begin_catch^⚠gnustep or apple_new

objc_constructInstance^⚠Deprecatedapple

objc_copyClassList^⚠

objc_copyClassNamesForImage^⚠apple

objc_copyImageNames^⚠apple

objc_copyProtocolList^⚠Non-objfw

objc_copyWeak^⚠

objc_destroyWeak^⚠

objc_destructInstance^⚠Deprecatedapple

objc_disposeClassPair^⚠Non-objfw

objc_duplicateClass^⚠apple

objc_end_catch^⚠gnustep or apple_new

objc_enumerationMutation^⚠apple or objfw

objc_exception_rethrow^⚠apple_new

objc_exception_throw^⚠

See objc-exception.h.

objc_exception_try_enter^⚠apple_old

objc_exception_try_exit^⚠apple_old

objc_getAssociatedObject^⚠Non-objfw

objc_getClass^⚠

objc_getClassList^⚠

objc_getFutureClass^⚠Deprecatedapple

objc_getMetaClass^⚠Non-objfw

objc_getProtocol^⚠Non-objfw

objc_getRequiredClass^⚠

objc_initWeak^⚠

objc_loadWeak^⚠

objc_loadWeakRetained^⚠

objc_lookUpClass^⚠

objc_moveWeak^⚠

objc_msgSend^⚠Non-objfw

objc_msgSendSuper^⚠apple

objc_msgSendSuper_stret^⚠apple and non-AArch64

objc_msgSend_fp2ret^⚠apple and x86-64

objc_msgSend_fpret^⚠Non-objfw and (x86-64 or x86)

objc_msgSend_stret^⚠Non-objfw and non-AArch64

objc_msg_lookup^⚠gnustep or objfw

objc_msg_lookup_stret^⚠objfw

objc_msg_lookup_super^⚠gnustep or objfw

objc_msg_lookup_super_stret^⚠objfw

objc_registerClassPair^⚠

objc_registerProtocol^⚠Non-objfw

objc_release^⚠

objc_removeAssociatedObjects^⚠Non-objfw

objc_removeExceptionHandler^⚠apple_new and macOS

objc_retain^⚠

objc_retainAutorelease^⚠

objc_retainAutoreleaseReturnValue^⚠

objc_retainAutoreleasedReturnValue^⚠

objc_retainBlock^⚠

objc_setAssociatedObject^⚠Non-objfw

objc_setEnumerationMutationHandler^⚠apple or objfw

objc_setExceptionMatcher^⚠apple_new

objc_setExceptionPreprocessor^⚠apple_new

objc_setForwardHandler^⚠apple or objfw

objc_setUncaughtExceptionHandler^⚠apple_new or objfw

objc_storeStrong^⚠

objc_storeWeak^⚠

objc_sync_enter^⚠

objc_sync_exit^⚠

object_copy^⚠Deprecatedapple

object_dispose^⚠DeprecatedNon-objfw

object_getClass^⚠

object_getClassName^⚠

object_getIndexedIvars^⚠Non-objfw

object_getInstanceVariable^⚠DeprecatedNon-objfw

object_getIvar^⚠Non-objfw

object_setClass^⚠

object_setInstanceVariable^⚠DeprecatedNon-objfw

object_setIvar^⚠Non-objfw

property_copyAttributeList^⚠Non-objfw

property_copyAttributeValue^⚠Non-objfw

property_getAttributes^⚠Non-objfw

property_getName^⚠Non-objfw

protocol_addMethodDescription^⚠Non-objfw

protocol_addProperty^⚠Non-objfw

protocol_addProtocol^⚠Non-objfw

protocol_conformsToProtocol^⚠

protocol_copyMethodDescriptionList^⚠Non-objfw

protocol_copyPropertyList^⚠Non-objfw

protocol_copyProtocolList^⚠Non-objfw

protocol_getMethodDescription^⚠Non-objfw

protocol_getName^⚠

protocol_getProperty^⚠Non-objfw

protocol_isEqual^⚠

sel_getName^⚠

sel_getUid^⚠Non-objfw

sel_isEqual^⚠

sel_isMapped^⚠apple

sel_registerName^⚠

Type Definitions

BOOL

The Objective-C BOOL type.

IMP

A nullable pointer to the start of a method implementation.

NSInteger

A signed integer value type.

NSUInteger

Describes an unsigned integer.

SEL

An immutable pointer to a selector.

id

A mutable pointer to an object / instance.

objc_AssociationPolicy

objc_exception_handlerapple_new and macOS

Remember that this is non-null!

objc_exception_matcherapple_new

Remember that this is non-null!

objc_exception_preprocessorapple_new

Remember that this is non-null!

objc_uncaught_exception_handlerapple_new

Remember that this is non-null!