Struct MainContext

pub struct MainContext { /* private fields */ }

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl MainContext

pub fn as_ptr(&self) -> *mut GMainContext

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GMainContext) -> &MainContext

Borrows the underlying C value.

impl MainContext

pub fn new() -> MainContext

pub fn with_flags(flags: MainContextFlags) -> MainContext

pub fn dispatch(&self)

pub fn is_owner(&self) -> bool

pub fn iteration(&self, may_block: bool) -> bool

pub fn pending(&self) -> bool

pub fn wakeup(&self)

pub fn default() -> MainContext

pub fn thread_default() -> Option<MainContext>

pub fn ref_thread_default() -> MainContext

impl MainContext

pub fn prepare(&self) -> (bool, i32)

pub fn find_source_by_id(&self, source_id: &SourceId) -> Option<Source>

pub fn invoke<F>(&self, func: F)

where F: FnOnce() + Send + 'static,

Invokes func on the main context.

If the current thread is the owner of the main context or the main context currently has no owner then func will be called directly from inside this function. If this behaviour is not desired and func should always be called asynchronously then use MainContext::spawn glib::idle_add instead.

pub fn invoke_with_priority<F>(&self, priority: Priority, func: F)

where F: FnOnce() + Send + 'static,

Invokes func on the main context with the given priority.

If the current thread is the owner of the main context or the main context currently has no owner then func will be called directly from inside this function. If this behaviour is not desired and func should always be called asynchronously then use MainContext::spawn glib::idle_add instead.

pub fn invoke_local<F>(&self, func: F)

where F: FnOnce() + 'static,

Invokes func on the main context.

Different to invoke(), this does not require func to be Send but can only be called from the thread that owns the main context.

This function panics if called from a different thread than the one that owns the main context.

Note that this effectively means that func is called directly from inside this function or otherwise panics immediately. If this behaviour is not desired and func should always be called asynchronously then use MainContext::spawn_local glib::idle_add_local instead.

pub fn invoke_local_with_priority<F>(&self, _priority: Priority, func: F)

where F: FnOnce() + 'static,

Invokes func on the main context with the given priority.

Different to invoke_with_priority(), this does not require func to be Send but can only be called from the thread that owns the main context.

This function panics if called from a different thread than the one that owns the main context.

Note that this effectively means that func is called directly from inside this function or otherwise panics immediately. If this behaviour is not desired and func should always be called asynchronously then use MainContext::spawn_local glib::idle_add_local instead.

pub fn with_thread_default<R, F>(&self, func: F) -> Result<R, BoolError>

where F: FnOnce() -> R,

Call closure with the main context configured as the thread default one.

The thread default main context is changed in a panic-safe manner before calling func and released again afterwards regardless of whether closure panicked or not.

This will fail if the main context is owned already by another thread.

pub fn acquire(&self) -> Result<MainContextAcquireGuard<'_>, BoolError>

Acquire ownership of the main context.

Ownership will automatically be released again once the returned acquire guard is dropped.

This will fail if the main context is owned already by another thread.

impl MainContext

pub fn spawn<R, F>(&self, f: F) -> JoinHandle<R>

where R: Send + 'static, F: Future<Output = R> + Send + 'static,

Spawn a new infallible Future on the main context.

This can be called from any thread and will execute the future from the thread where main context is running, e.g. via a MainLoop.

pub fn spawn_local<R, F>(&self, f: F) -> JoinHandle<R>

where R: 'static, F: Future<Output = R> + 'static,

Spawn a new infallible Future on the main context.

The given Future does not have to be Send.

This can be called only from the thread where the main context is running, e.g. from any other Future that is executed on this main context, or after calling with_thread_default or acquire on the main context.

pub fn spawn_with_priority<R, F>( &self, priority: Priority, f: F, ) -> JoinHandle<R>

where R: Send + 'static, F: Future<Output = R> + Send + 'static,

Spawn a new infallible Future on the main context, with a non-default priority.

This can be called from any thread and will execute the future from the thread where main context is running, e.g. via a MainLoop.

pub fn spawn_local_with_priority<R, F>( &self, priority: Priority, f: F, ) -> JoinHandle<R>

where R: 'static, F: Future<Output = R> + 'static,

Spawn a new infallible Future on the main context, with a non-default priority.

The given Future does not have to be Send.

This can be called only from the thread where the main context is running, e.g. from any other Future that is executed on this main context, or after calling with_thread_default or acquire on the main context.

pub fn spawn_from_within<R, F>( &self, func: impl FnOnce() -> F + Send + 'static, ) -> SpawnWithinJoinHandle<R>

where R: Send + 'static, F: Future<Output = R> + 'static,

Spawn a new infallible Future on the main context from inside the main context.

The given Future does not have to be Send but the closure to spawn it has to be.

This can be called only from any thread.

pub fn spawn_from_within_with_priority<R, F>( &self, priority: Priority, func: impl FnOnce() -> F + Send + 'static, ) -> SpawnWithinJoinHandle<R>

where R: Send + 'static, F: Future<Output = R> + 'static,

Spawn a new infallible Future on the main context from inside the main context.

The given Future does not have to be Send but the closure to spawn it has to be.

This can be called only from any thread.

pub fn block_on<F>(&self, f: F) -> <F as Future>::Output

where F: Future,

Runs a new, infallible Future on the main context and block until it finished, returning the result of the Future.

The given Future does not have to be Send or 'static.

This must only be called if no MainLoop or anything else is running on this specific main context.

Trait Implementations

impl Clone for MainContext

fn clone(&self) -> MainContext

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for MainContext

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

Formats the value using the given formatter.

impl Default for MainContext

fn default() -> MainContext

Returns the “default value” for a type.

impl From<MainContext> for Value

fn from(s: MainContext) -> Value

Converts to this type from the input type.

impl HasParamSpec for MainContext

type ParamSpec = ParamSpecBoxed

type SetValue = MainContext

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecBoxedBuilder<'_, MainContext>

fn param_spec_builder() -> <MainContext as HasParamSpec>::BuilderFn

impl Hash for MainContext

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LocalSpawn for MainContext

fn spawn_local_obj( &self, f: LocalFutureObj<'static, ()>, ) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

fn status_local(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks.

impl Ord for MainContext

fn cmp(&self, other: &MainContext) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MainContext

fn eq(&self, other: &MainContext) -> 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 PartialOrd for MainContext

fn partial_cmp(&self, other: &MainContext) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Spawn for MainContext

fn spawn_obj(&self, f: FutureObj<'static, ()>) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

fn status(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks.

impl StaticType for MainContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MainContext

impl Send for MainContext

impl StructuralPartialEq for MainContext

impl Sync for MainContext