qtbridge-runtime 0.3.0

Qt Bridge: bridging code to be run in applications.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only

use crate::DynamicMetaObjectBuilder;

/// Describes the Rust-side additions to a QObject's meta-object: the
/// signals, slots, and properties declared on the type.
///
/// Pure description: the realized meta-object and metatypes live on the
/// proxy pair in [`crate::QObjectHolder`], since they chain to the concrete
/// C++ proxy class.
/// # Safety
///
/// [`build_dynamic_meta_type`](QMetaInfo::build_dynamic_meta_type) declares the
/// argument, return, and property types the C++ metaobject sizes its dispatch
/// buffers from. These must match what the paired [`DispatchMetaCall`] impl
/// marshals, or the C++ dispatch reads/writes wrongly sized buffers (undefined
/// behavior). Implementations are generated by `#[qobject]`. Must be
/// in sync with the `DispatchMetaCall` implementation.
#[doc(hidden)]
pub unsafe trait QMetaInfo : 'static {
    /// The class_name in the Qt meta-object system
    fn class_name() -> &'static str {
        std::any::type_name::<Self>()
    }

    /// This function takes the meta_obj_builder and builds a meta object
    /// that contains all slots, signals and properties for the respective type.
    /// This function is usually implemented by a macro.
    fn build_dynamic_meta_type(meta_obj_builder: std::pin::Pin<&mut DynamicMetaObjectBuilder>);
}