Struct objc2::runtime::Class

#[repr(C)]
pub struct Class(_);

A type that represents an Objective-C class.

Implementations

impl Class

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

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

pub fn classes() -> Malloc<[&'static Self]>

Available on crate feature malloc only.

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 the class.

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

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

pub fn metaclass(&self) -> &Self

Returns the metaclass of self.

pub fn instance_size(&self) -> usize

Returns the size of instances of self.

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.

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) -> Malloc<[&Method]>

Available on crate feature malloc only.

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) -> Malloc<[&Protocol]>

Available on crate feature malloc only.

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

pub fn instance_variables(&self) -> Malloc<[&Ivar]>

Available on crate feature malloc only.

Describes the instance variables declared by self.

pub fn responds_to(&self, sel: Sel) -> bool

Check whether instances of this class respond to the given selector.

This doesn’t call respondsToSelector:, but works entirely within the runtime, which means it’ll always be safe to call, but may not return exactly what you’d expect if respondsToSelector: has been overwritten.

That said, it will always return true if an instance of the class responds to the selector, but may return false if they don’t directly (e.g. does so by using forwarding instead).

pub fn verify_sel<A, R>(&self, sel: Sel) -> Result<(), VerificationError> where
    A: EncodeArguments,
    R: EncodeConvert, 

Available on crate feature malloc only.

Verify argument and return types for a given selector.

This will look up the encoding of the method for the given selector and return a VerificationError if any encodings differ for the arguments A and return type R.

Example

let cls = class!(NSObject);
let sel = sel!(isKindOfClass:);
// Verify that `isKindOfClass:`:
// - Exists on the class
// - Takes a class as a parameter
// - Returns a BOOL
let result = cls.verify_sel::<(&Class,), bool>(sel);
assert!(result.is_ok());

Trait Implementations

impl Debug for Class

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

Formats the value using the given formatter.

impl Hash for Class

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> MessageReceiver for &'a Class

unsafe fn send_message<A, R>(self, sel: Sel, args: A) -> R where
    A: MessageArguments,
    R: EncodeConvert, 

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

unsafe fn send_super_message<A, R>(
    self,
    superclass: &Class,
    sel: Sel,
    args: A
) -> R where
    A: MessageArguments,
    R: EncodeConvert, 

Sends a message to a specific superclass with the given selector and arguments.

impl PartialEq<Class> for Class

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl RefEncode for Class

const ENCODING_REF: Encoding = Encoding::Class

The Objective-C type-encoding for a reference of this type.

impl Eq for Class

impl RefUnwindSafe for Class

impl Send for Class

impl Sync for Class

impl UnwindSafe for Class