Struct glib::MainContext

#[repr(transparent)]
pub struct MainContext { /* private fields */ }

Implementations

impl MainContext

pub fn new() -> MainContext

pub fn with_flags(flags: MainContextFlags) -> MainContext

Available on crate feature v2_72 only.

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: Sized>(&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 channel<T>(priority: Priority) -> (Sender<T>, Receiver<T>)

Creates a channel for a main context.

The Receiver has to be attached to a main context at a later time, together with a closure that will be called for every item sent to a Sender.

The Sender can be cloned and both the Sender and Receiver can be sent to different threads as long as the item type implements the Send trait.

When the last Sender is dropped the channel is removed from the main context. If the Receiver is dropped and not attached to a main context all sending to the Sender will fail.

The returned Sender behaves the same as std::sync::mpsc::Sender.

pub fn sync_channel<T>(
    priority: Priority,
    bound: usize
) -> (SyncSender<T>, Receiver<T>)

Creates a synchronous channel for a main context with a given bound on the capacity of the channel.

The Receiver has to be attached to a main context at a later time, together with a closure that will be called for every item sent to a SyncSender.

The SyncSender can be cloned and both the SyncSender and Receiver can be sent to different threads as long as the item type implements the Send trait.

When the last SyncSender is dropped the channel is removed from the main context. If the Receiver is dropped and not attached to a main context all sending to the SyncSender will fail.

The returned SyncSender behaves the same as std::sync::mpsc::SyncSender.

impl MainContext

pub fn spawn<F: Future<Output = ()> + Send + 'static>(&self, f: F) -> SourceId

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<F: Future<Output = ()> + 'static>(&self, f: F) -> SourceId

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<F: Future<Output = ()> + Send + 'static>(
    &self,
    priority: Priority,
    f: F
) -> SourceId

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<F: Future<Output = ()> + 'static>(
    &self,
    priority: Priority,
    f: F
) -> SourceId

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 block_on<F: Future>(&self, f: F) -> F::Output

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) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MainContext

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

Formats the value using the given formatter.

impl Default for MainContext

fn default() -> Self

Returns the “default value” for a type.

impl Hash for MainContext

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

Feeds this value into the given Hasher.

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<MainContext> for MainContext

fn eq(&self, other: &MainContext) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<MainContext> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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 StructuralEq for MainContext

impl StructuralPartialEq for MainContext

impl Sync for MainContext