cxx-qt 0.9.1

Safe interop between Rust and Qt
Documentation 
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
32
33
34
35
36
37
38
39
40

// SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
// SPDX-FileContributor: Andrew Hayzen <andrew.hayzen@kdab.com>
//
// SPDX-License-Identifier: MIT OR Apache-2.0

use crate::QMetaObjectConnection;

/// Represents a guard to a signal-slot (or signal-functor) connection.
///
/// This struct can be created from a [`QMetaObjectConnection`].
///
/// Note that when this struct is dropped the connection is disconnected.
/// So to keep a connection active either hold onto the struct for the duration
/// that the connection should be active or call `release`, hence the `#[must_use]`.
#[must_use]
pub struct QMetaObjectConnectionGuard {
    connection: QMetaObjectConnection,
}

impl From<QMetaObjectConnection> for QMetaObjectConnectionGuard {
    fn from(connection: QMetaObjectConnection) -> Self {
        Self { connection }
    }
}

impl Drop for QMetaObjectConnectionGuard {
    /// Disconnect and deconstruct the connection.
    fn drop(&mut self) {
        self.connection.disconnect();
    }
}

impl QMetaObjectConnectionGuard {
    /// Release the connection without disconnecting.
    pub fn release(mut self) -> QMetaObjectConnection {
        // Take the connection as our Drop implementation disconnects automatically
        // whereas we just want to release
        core::mem::take(&mut self.connection)
    }
}