Struct gio::Cancellable

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

GCancellable is a thread-safe operation cancellation stack used throughout GIO to allow for cancellation of synchronous and asynchronous operations.

Implements

CancellableExt, glib::ObjectExt, CancellableExtManual

Implementations

impl Cancellable

pub const NONE: Option<&'static Cancellable> = None

pub fn new() -> Cancellable

Creates a new Cancellable object.

Applications that want to start one or more operations that should be cancellable should create a Cancellable and pass it to the operations.

One Cancellable can be used in multiple consecutive operations or in multiple concurrent operations.

Returns

a Cancellable.

pub fn current() -> Option<Cancellable>

Gets the top cancellable from the stack.

Returns

a Cancellable from the top of the stack, or None if the stack is empty.

Trait Implementations

impl Clone for Cancellable

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 Cancellable

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

Formats the value using the given formatter.

impl Default for Cancellable

fn default() -> Self

Returns the “default value” for a type.

impl Display for Cancellable

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

Formats the value using the given formatter.

impl Hash for Cancellable

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 Ord for Cancellable

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Cancellable

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Cancellable

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

fn partial_cmp(&self, other: &OT) -> 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 StaticType for Cancellable

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Cancellable

impl Send for Cancellable

impl Sync for Cancellable