Struct gio::Task

pub struct Task<V: ValueType + Send> { /* private fields */ }

Task provides idiomatic access to gio’s GTask API, for instance by being generic over their value type, while not completely departing from the underlying C API. Task is Send and Sync and requires its value to also be Send and Sync, thus is useful to to implement gio style asynchronous tasks that run in threads. If you need to only run tasks in glib main loop see the LocalTask type.

The constructors of LocalTask and Task is marked as unsafe because this API does not allow to automatically enforce all the invariants required to be a completely safe abstraction. The caller is responsible to ensure the following requirements are satisfied

• You should not create a LocalTask, upcast it to a glib::Object and then downcast it to a Task, as this will bypass the thread safety requirements
• You should ensure that the return_result, return_error_if_cancelled and propagate() methods are only called once.

GLib type: GObject with reference counted clone semantics.

Implementations

impl<V: Into<Value> + ValueType + Send> Task<V>

pub unsafe fn new<S, P, Q>( source_object: Option<&S>, cancellable: Option<&P>, callback: Q, ) -> Self

where S: IsA<Object> + Send, P: IsA<Cancellable>, Q: FnOnce(Task<V>, Option<&S>) + Send + 'static,

pub fn cancellable(&self) -> Option<Cancellable>

pub fn is_check_cancellable(&self) -> bool

pub fn set_check_cancellable(&self, check_cancellable: bool)

pub fn set_name(&self, name: Option<&str>)

Available on crate feature v2_60 only.

pub fn set_return_on_cancel(&self, return_on_cancel: bool) -> bool

pub fn is_valid( result: &impl IsA<AsyncResult>, source_object: Option<&impl IsA<Object>>, ) -> bool

pub fn priority(&self) -> Priority

pub fn set_priority(&self, priority: Priority)

pub fn is_completed(&self) -> bool

pub fn context(&self) -> MainContext

pub fn name(&self) -> Option<GString>

Available on crate feature v2_60 only.

pub fn is_return_on_cancel(&self) -> bool

pub fn had_error(&self) -> bool

pub fn connect_completed_notify<F>(&self, f: F) -> SignalHandlerId

where F: Fn(&Task<V>) + Send + 'static,

pub unsafe fn return_error_if_cancelled(&self) -> bool

pub unsafe fn return_result(self, result: Result<V, Error>)

pub unsafe fn propagate(self) -> Result<V, Error>

impl<V: ValueType + Send> Task<V>

pub fn run_in_thread<S, Q>(&self, task_func: Q)

where S: IsA<Object> + Send, Q: FnOnce(Self, Option<&S>, Option<&Cancellable>) + Send + 'static,

Trait Implementations

impl<V: ValueType + Send> Clone for Task<V>

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl<V: ValueType + Send> Debug for Task<V>

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

Formats the value using the given formatter.

impl<V: ValueType + Send> HasParamSpec for Task<V>

type ParamSpec = ParamSpecObject

type SetValue = Task<V>

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

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Task<V>>

fn param_spec_builder() -> Self::BuilderFn

impl<V: ValueType + Send> Hash for Task<V>

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

where H: Hasher,

Hashes the memory address of this object.

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<V: ValueType + Send> Ord for Task<V>

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 + PartialOrd,

Restrict a value to a certain interval.

impl<V: ValueType + Send> ParentClassIs for Task<V>

type Parent = Object

impl<OT: ObjectType, V: ValueType + Send> PartialEq<OT> for Task<V>

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType, V: ValueType + Send> PartialOrd<OT> for Task<V>

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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<V: ValueType + Send> StaticType for Task<V>

fn static_type() -> Type

Returns the type identifier of Self.

impl<V: ValueType + Send> Eq for Task<V>

impl<V: ValueType + Send> IsA<AsyncResult> for Task<V>

impl<V: ValueType + Send> Send for Task<V>

impl<V: ValueType + Send> Sync for Task<V>