Struct Source 

pub struct Source { /* private fields */ }

The GSource struct is an opaque data type representing an event source.

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

Implementations

impl Source

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

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GSource) -> &Self

Borrows the underlying C value.

impl Source

pub fn add_child_source(&self, child_source: &Source)

t need @child_source to do anything on its own when it triggers, you can call g_source_set_dummy_callback() on it to set a callback that does nothing (except return true if appropriate).

The @self will hold a reference on @child_source while @child_source is attached to it.

This API is only intended to be used by implementations of Source. Do not call this API on a Source that you did not create.

child_source

poll

pub fn destroy(&self)

pub fn can_recurse(&self) -> bool

Checks whether a source is allowed to be called recursively.

See GLib::Source::set_can_recurse().

Returns

whether recursion is allowed

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

Gets a name for the source, used in debugging and profiling.

The name may be NULL if it has never been set with GLib::Source::set_name().

Returns

the name of the source

pub fn priority(&self) -> i32

Gets the priority of a source.

Returns

the priority of the source

pub fn ready_time(&self) -> i64

of @self, as set by GLib::Source::set_ready_time().

Any time before or equal to the current monotonic time (including zero) is an indication that the source will fire immediately.

Returns

never

pub fn time(&self) -> i64

Gets the time to be used when checking this source.

The advantage of calling this function over calling monotonic_time() directly is that when checking multiple sources, GLib can cache a single value instead of having to repeatedly get the system monotonic time.

The time here is the system monotonic time, if available, or some other reasonable alternative otherwise. See monotonic_time().

Returns

the monotonic time in microseconds

pub fn is_destroyed(&self) -> bool

idle_id_mutex);

return FALSE; }

Calls to this function from a thread other than the one acquired by the
[`MainContext`][crate::MainContext] the [`Source`][crate::Source] is attached to are typically
redundant, as the source could be destroyed immediately after this function
returns. However, once a source is destroyed it cannot be un-destroyed, so
this function can be used for opportunistic checks from any thread.

# Returns

true if the source has been destroyed, false otherwise

pub fn remove_child_source(&self, child_source: &Source)

Detaches @child_source from @self and destroys it.

This API is only intended to be used by implementations of Source. Do not call this API on a Source that you did not create.

child_source

a source previously passed to add_child_source()

impl Source

pub fn attach(&self, context: Option<&MainContext>) -> SourceId

pub fn context(&self) -> Option<MainContext>

Gets the MainContext with which the source is associated.

You can call this on a source that has been destroyed, provided that the MainContext it was attached to still exists (in which case it will return that MainContext). In particular, you can always call this function on the source returned from main_current_source(). But calling this function on a source whose MainContext has been destroyed is an error.

If the associated MainContext could be destroy concurrently from a different thread, then this function is not safe to call and [dup_context()][Self::dup_context()] should be used instead.

Returns

the main context with which the source is associated, or NULL if the context has not yet been added to a source

Trait Implementations

impl Clone for Source

fn clone(&self) -> Self

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 Source

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

Formats the value using the given formatter.

impl Eq for Source

impl From<Source> for Value

fn from(s: Source) -> Self

Converts to this type from the input type.

impl HasParamSpec for Source

type ParamSpec = ParamSpecBoxed

type SetValue = Source

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Source

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Source

fn cmp(&self, other: &Source) -> 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 Source

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

fn partial_cmp(&self, other: &Source) -> 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 Send for Source

impl StaticType for Source

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralPartialEq for Source

impl Sync for Source