Struct Closure

pub struct Closure { /* private fields */ }

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

Implementations

impl Closure

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

impl Closure

pub fn new<F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static>( callback: F, ) -> Self

Creates a new closure around a Rust closure.

Note that RustClosure provides more convenient and non-unsafe API for invoking closures. This type mostly exists for FFI interop.

Panics

Invoking the closure with wrong argument types or returning the wrong return value type will panic.

Example

use glib::prelude::*;

let closure = glib::Closure::new(|values| {
    let x = values[0].get::<i32>().unwrap();
    Some((x + 1).to_value())
});

// Invoking non-Rust closures is unsafe because of possibly missing
// argument and return value type checks.
let res = unsafe {
    closure
        .invoke_with_values(glib::Type::I32, &[1i32.to_value()])
        .and_then(|v| v.get::<i32>().ok())
        .expect("Invalid return value")
};

assert_eq!(res, 2);

pub fn new_local<F: Fn(&[Value]) -> Option<Value> + 'static>( callback: F, ) -> Self

Creates a new closure around a Rust closure.

Note that RustClosure provides more convenient and non-unsafe API for invoking closures. This type mostly exists for FFI interop.

Panics

Invoking the closure with wrong argument types or returning the wrong return value type will panic.

Invoking the closure from a different thread than this one will panic.

pub unsafe fn new_unsafe<F: Fn(&[Value]) -> Option<Value>>(callback: F) -> Self

Creates a new closure around a Rust closure.

Safety

The captured variables of the closure must stay valid as long as the return value of this constructor does, and it must be valid to call the closure from any thread that is used by callers.

pub unsafe fn invoke_with_values( &self, return_type: Type, values: &[Value], ) -> Option<Value>

Invokes the closure with the given arguments.

For invalidated closures this returns the “default” value of the return type.

Safety

The argument types and return value type must match the ones expected by the closure or otherwise the behaviour is undefined.

Closures created from Rust via e.g. Closure::new will panic on type mismatches but this is not guaranteed for closures created from other languages.

pub fn invalidate(&self)

Invalidates the closure.

Invoking an invalidated closure has no effect.

Trait Implementations

impl AsRef<Closure> for Closure

fn as_ref(&self) -> &Closure

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Closure> for RustClosure

fn as_ref(&self) -> &Closure

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Closure

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 Closure

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

Formats the value using the given formatter.

impl From<Closure> for Value

fn from(s: Closure) -> Self

Converts to this type from the input type.

impl From<RustClosure> for Closure

fn from(c: RustClosure) -> Self

Converts to this type from the input type.

impl HasParamSpec for Closure

type ParamSpec = ParamSpecBoxed

type SetValue = Closure

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Closure

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 Closure

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Closure

impl Send for Closure

impl StructuralPartialEq for Closure

impl Sync for Closure