Struct LocalTask 

pub struct LocalTask<V: ValueType> { /* private fields */ }

LocalTask 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. LocalTask does not require its value to be Send and Sync and thus is useful to to implement gio style asynchronous tasks that run in the glib main loop. If you need to run tasks in threads see the Task 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. See the Task type for more details.

GLib type: GObject with reference counted clone semantics.

Implementations

impl<V: Into<Value> + ValueType> LocalTask<V>

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

where S: IsA<Object>, P: IsA<Cancellable>, Q: FnOnce(LocalTask<V>, Option<&S>) + '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(&LocalTask<V>) + 'static,

pub fn return_error_if_cancelled(&self) -> bool

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

Set the result of the task

Safety

The value must be read with Task::propagate, g_task_propagate_value or g_task_propagate_pointer.

pub fn return_boolean_result(self, result: Result<bool, Error>)

Set the result of the task as a boolean

Safety

The value must be read with Task::propagate_boolean, or g_task_propagate_boolean.

pub fn return_int_result(self, result: Result<isize, Error>)

Set the result of the task as an int

Safety

The value must be read with Task::propagate_int, or g_task_propagate_int.

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

Gets the result of the task and transfers ownership of it

Safety

This must only be called once, and only if the result was set via Task::return_result, g_task_return_value or g_task_return_pointer.

pub unsafe fn propagate_boolean(self) -> Result<bool, Error>

Gets the result of the task as a boolean, or the error

Safety

This must only be called once, and only if the result was set via Task::return_boolean_result, or g_task_return_boolean.

pub unsafe fn propagate_int(self) -> Result<isize, Error>

Gets the result of the task as an int, or the error

Safety

This must only be called once, and only if the result was set via Task::return_int_result, or g_task_return_int.

Trait Implementations

impl<V: ValueType> Clone for LocalTask<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> Debug for LocalTask<V>

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

Formats the value using the given formatter.

impl<V: ValueType> HasParamSpec for LocalTask<V>

type ParamSpec = ParamSpecObject

type SetValue = LocalTask<V>

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

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

fn param_spec_builder() -> Self::BuilderFn

impl<V: ValueType> Hash for LocalTask<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> Ord for LocalTask<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,

Restrict a value to a certain interval.

impl<V: ValueType> ParentClassIs for LocalTask<V>

type Parent = Object

impl<OT: ObjectType, V: ValueType> PartialEq<OT> for LocalTask<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

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

impl<OT: ObjectType, V: ValueType> PartialOrd<OT> for LocalTask<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

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<V: ValueType> StaticType for LocalTask<V>

fn static_type() -> Type

Returns the type identifier of Self.

impl<V: ValueType> Eq for LocalTask<V>

impl<V: ValueType> IsA<AsyncResult> for LocalTask<V>