Struct objc2::declare::ClassBuilder

pub struct ClassBuilder { /* private fields */ }

A type for declaring a new class and adding new methods and ivars to it before registering it.

Implementations

impl ClassBuilder

pub fn new(name: &str, superclass: &Class) -> Option<Self>

Constructs a ClassBuilder with the given name and superclass.

Returns None if the class couldn’t be allocated, or a class with that name already exist.

pub fn root<F>(name: &str, intitialize_fn: F) -> Option<Self> where
    F: MethodImplementation<Callee = Class, Args = (), Ret = ()>, 

Constructs a ClassBuilder declaring a new root class with the given name.

Returns None if the class couldn’t be allocated.

An implementation for +initialize must also be given; the runtime calls this method for all classes, so it must be defined on root classes.

Note that implementing a root class is not a simple endeavor! For example, your class probably cannot be passed to Cocoa code unless the entire NSObject protocol is implemented. Functionality it expects, like implementations of -retain and -release used by ARC, will not be present otherwise.

pub unsafe fn add_method<T, F>(&mut self, sel: Sel, func: F) where
    T: Message + ?Sized,
    F: MethodImplementation<Callee = T>, 

Adds a method with the given name and implementation.

Panics

Panics if the method wasn’t sucessfully added or if the selector and function take different numbers of arguments.

Safety

The caller must ensure that the types match those that are expected when the method is invoked from Objective-C.

pub unsafe fn add_class_method<F>(&mut self, sel: Sel, func: F) where
    F: MethodImplementation<Callee = Class>, 

Adds a class method with the given name and implementation.

Panics

Panics if the method wasn’t sucessfully added or if the selector and function take different numbers of arguments.

Safety

The caller must ensure that the types match those that are expected when the method is invoked from Objective-C.

pub fn add_ivar<T: Encode>(&mut self, name: &str)

Adds an ivar with type T and the provided name.

Panics

If the ivar wasn’t successfully added.

pub fn add_protocol(&mut self, proto: &Protocol)

Adds the given protocol to self.

Panics

If the protocol wasn’t successfully added.

pub fn register(self) -> &'static Class

Registers the ClassBuilder, consuming it, and returns a reference to the newly registered Class.

Trait Implementations

impl Debug for ClassBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for ClassBuilder

fn drop(&mut self)

Executes the destructor for this type.

impl Send for ClassBuilder

impl Sync for ClassBuilder