Struct Metaclass

pub struct Metaclass<T = Borrowed> { /* private fields */ }

Metaclass provides type inspection mechanism for Kanzi classes.

Classes deriving from Object can register information about their type, properties, methods, messages by using Metaclass and accompanying macros.

Such information is used by serialization, scripting and to display friendly type information in Kanzi Studio.

Implementations

impl<T> Metaclass<T>

pub const fn as_ptr(&self) -> *mut MetaclassWrapper

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

impl Metaclass

pub fn find( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<Option<Metaclass>, Error>

Finds an existing metaclass by name.

impl Metaclass

pub fn get_property_type_iterator(&self) -> Result<PropertyTypeIterator, Error>

Gets iterator over properties defined on a provided Metaclass.

pub fn get_property_types(&self) -> Result<Vec<PropertyType<()>>, Error>

Gets all properties defined on a provided Metaclass.

pub fn get_message_type_iterator(&self) -> Result<MessageTypeIterator, Error>

Gets iterator over messages defined on a provided Metaclass.

pub fn get_message_types( &self, ) -> Result<Vec<MessageType<MessageArguments>>, Error>

Gets all messages defined on a provided Metaclass.

pub fn get_nested_metaclass_iterator( &self, ) -> Result<NestedMetaclassIterator, Error>

Gets iterator over nested metaclasses defined on a provided Metaclass.

pub fn get_nested_metaclasses(&self) -> Result<Vec<Metaclass>, Error>

Gets all nested metaclasses defined on a provided Metaclass.

impl<T> Metaclass<T>

pub fn create_instance( &self, domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<Option<Object>, Error>

Creates an instance of a class this metaclass describes.

Returns

• If None is returned, metaclass doesn’t specify Object as a base metaclass.

pub fn compare<E>(&self, rhs: &Metaclass<E>) -> Result<bool, Error>

Compares two metaclasses.

pub fn get_name(&self) -> Result<KanziString, Error>

Gets the fully qualified name of the message type.

assert_eq!(
    Node2D::get_static_metaclass().get_name()?,
    "Kanzi.Node2D",
);

pub fn get_base(&self) -> Result<Option<Metaclass<T>>, Error>

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

pub fn get_editor_info(&self) -> Result<Option<EditorInfo>, Error>

Gets editor info for the specified metaclass.

pub fn is_abstract(&self) -> Result<bool, Error>

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

pub fn is_derived_from<E>(&self, base: &Metaclass<E>) -> Result<bool, Error>

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

Trait Implementations

impl<T> Debug for Metaclass<T>

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

Formats the value using the given formatter.

impl<T> Drop for Metaclass<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, E> PartialEq<Metaclass<E>> for Metaclass<T>

fn eq(&self, rhs: &Metaclass<E>) -> 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<T> Eq for Metaclass<T>

impl<T> Send for Metaclass<T>

impl<T> Sync for Metaclass<T>