Struct Class

#[repr(C)]
pub struct Class { /* private fields */ }

A type that represents an Objective-C class.

Implementations

impl Class

pub fn get(name: &str) -> Option<&'static Class>

Returns the class definition of a specified class, or None if the class is not registered with the Objective-C runtime.

pub fn classes() -> MallocBuffer<&'static Class>

Obtains the list of registered class definitions.

pub fn classes_count() -> usize

Returns the total number of registered classes.

pub fn name(&self) -> &str

Returns the name of self.

pub fn superclass(&self) -> Option<&Class>

Returns the superclass of self, or None if self is a root class.

pub fn metaclass(&self) -> &Class

Returns the metaclass of self.

pub fn instance_size(&self) -> usize

Returns the size of instances of self.

Examples found in repository

examples/example.rs (line 11)

fn main() {
    // Get a class
    let cls = class!(NSObject);
    println!("NSObject size: {}", cls.instance_size());

    // Inspect its ivars
    println!("NSObject ivars:");
    for ivar in cls.instance_variables().iter() {
        println!("{}", ivar.name());
    }

    // Allocate an instance
    let obj = unsafe {
        let obj: *mut Object = msg_send![cls, alloc];
        let obj: *mut Object = msg_send![obj, init];
        StrongPtr::new(obj)
    };
    println!("NSObject address: {:p}", obj);

    // Access an ivar of the object
    let isa: *const Class = unsafe {
        *(**obj).get_ivar("isa")
    };
    println!("NSObject isa: {:?}", isa);

    // Inspect a method of the class
    let hash_sel = sel!(hash);
    let hash_method = cls.instance_method(hash_sel).unwrap();
    let hash_return = hash_method.return_type();
    println!("-[NSObject hash] return type: {:?}", hash_return);
    assert!(hash_return == usize::encode());

    // Invoke a method on the object
    let hash: usize = unsafe {
        msg_send![*obj, hash]
    };
    println!("NSObject hash: {}", hash);
}

pub fn instance_method(&self, sel: Sel) -> Option<&Method>

Returns a specified instance method for self, or None if self and its superclasses do not contain an instance method with the specified selector.

Examples found in repository

examples/example.rs (line 35)

fn main() {
    // Get a class
    let cls = class!(NSObject);
    println!("NSObject size: {}", cls.instance_size());

    // Inspect its ivars
    println!("NSObject ivars:");
    for ivar in cls.instance_variables().iter() {
        println!("{}", ivar.name());
    }

    // Allocate an instance
    let obj = unsafe {
        let obj: *mut Object = msg_send![cls, alloc];
        let obj: *mut Object = msg_send![obj, init];
        StrongPtr::new(obj)
    };
    println!("NSObject address: {:p}", obj);

    // Access an ivar of the object
    let isa: *const Class = unsafe {
        *(**obj).get_ivar("isa")
    };
    println!("NSObject isa: {:?}", isa);

    // Inspect a method of the class
    let hash_sel = sel!(hash);
    let hash_method = cls.instance_method(hash_sel).unwrap();
    let hash_return = hash_method.return_type();
    println!("-[NSObject hash] return type: {:?}", hash_return);
    assert!(hash_return == usize::encode());

    // Invoke a method on the object
    let hash: usize = unsafe {
        msg_send![*obj, hash]
    };
    println!("NSObject hash: {}", hash);
}

pub fn instance_variable(&self, name: &str) -> Option<&Ivar>

Returns the ivar for a specified instance variable of self, or None if self has no ivar with the given name.

pub fn instance_methods(&self) -> MallocBuffer<&Method>

Describes the instance methods implemented by self.

pub fn conforms_to(&self, proto: &Protocol) -> bool

Checks whether this class conforms to the specified protocol.

pub fn adopted_protocols(&self) -> MallocBuffer<&Protocol>

Get a list of the protocols to which this class conforms.

pub fn instance_variables(&self) -> MallocBuffer<&Ivar>

Describes the instance variables declared by self.

Examples found in repository

examples/example.rs (line 15)

fn main() {
    // Get a class
    let cls = class!(NSObject);
    println!("NSObject size: {}", cls.instance_size());

    // Inspect its ivars
    println!("NSObject ivars:");
    for ivar in cls.instance_variables().iter() {
        println!("{}", ivar.name());
    }

    // Allocate an instance
    let obj = unsafe {
        let obj: *mut Object = msg_send![cls, alloc];
        let obj: *mut Object = msg_send![obj, init];
        StrongPtr::new(obj)
    };
    println!("NSObject address: {:p}", obj);

    // Access an ivar of the object
    let isa: *const Class = unsafe {
        *(**obj).get_ivar("isa")
    };
    println!("NSObject isa: {:?}", isa);

    // Inspect a method of the class
    let hash_sel = sel!(hash);
    let hash_method = cls.instance_method(hash_sel).unwrap();
    let hash_return = hash_method.return_type();
    println!("-[NSObject hash] return type: {:?}", hash_return);
    assert!(hash_return == usize::encode());

    // Invoke a method on the object
    let hash: usize = unsafe {
        msg_send![*obj, hash]
    };
    println!("NSObject hash: {}", hash);
}

Trait Implementations

impl Debug for Class

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

Formats the value using the given formatter.

impl<'a> Encode for &'a Class

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl<'a> Encode for &'a mut Class

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl Message for Class

unsafe fn send_message<A, R>( &self, sel: Sel, args: A, ) -> Result<R, MessageError>

where Self: Sized, A: MessageArguments, R: Any,

Sends a message to self with the given selector and arguments.

fn verify_message<A, R>(&self, sel: Sel) -> Result<(), MessageError>

where Self: Sized, A: EncodeArguments, R: Encode,

Verifies that the argument and return types match the encoding of the method for the given selector.

impl PartialEq for Class

fn eq(&self, other: &Class) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Class