Struct cxx_qt::CxxQtThread

#[repr(C)]
pub struct CxxQtThread<T>
where
    T: Threading,
{ /* private fields */ }

A threading helper which is created from a QObject that implements Threading.

This allows for queueing closures onto the Qt event loop from a background thread as CxxQtThread implements Send.

When the Rust thread needs to update a value in the QObject it can then queue a closure to the thread. This closure will be executed on the thread the QObject lives in while holding a lock on the Rust object. Updating the QObject is then thread-safe.

See the Threading example for more information.

Implementations

impl<T> CxxQtThread<T>

where T: Threading,

pub fn queue<F>(&self, f: F) -> Result<(), Exception>

where F: FnOnce(Pin<&mut T>) + Send + 'static,

Queue the given closure onto the Qt event loop for this QObject

The first argument of the closure is a pinned mutable reference to the QObject. With this parameter, you can then update the QObject to reflect any state changes that have occured in the background thread.

Trait Implementations

impl<T> Clone for CxxQtThread<T>

where T: Threading,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Drop for CxxQtThread<T>

where T: Threading,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> ExternType for CxxQtThread<T>

where T: ExternType + Threading,

type Id = <T as Threading>::ThreadingTypeId

A type-level representation of the type’s C++ namespace and type name.

type Kind = Trivial

Either cxx::kind::Opaque or cxx::kind::Trivial.

impl<T> Send for CxxQtThread<T>

where T: Threading,