Struct RustClosure

pub struct RustClosure(/* private fields */);

Implementations

impl RustClosure

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

Creates a new closure around a Rust closure.

See glib::closure! for a way to create a closure with concrete types.

Panics

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

Example

use glib::prelude::*;

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

assert_eq!(
    closure.invoke::<i32>(&[&1i32]),
    2,
);

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

Creates a new closure around a Rust closure.

See glib::closure_local! for a way to create a closure with concrete types.

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 fn invoke<R: TryFromClosureReturnValue>(&self, values: &[&dyn ToValue]) -> R

Invokes the closure with the given arguments.

For invalidated closures this returns the “default” value of the return type. For nullable types this is None, which means that e.g. requesting R = String will panic will R = Option<String> will return None.

Panics

The argument types and return value type must match the ones expected by the closure or otherwise this function panics.

pub 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.

Panics

The argument types and return value type must match the ones expected by the closure or otherwise this function panics.

pub fn invalidate(&self)

Invalidates the closure.

Invoking an invalidated closure has no effect.

Trait Implementations

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 RustClosure

fn clone(&self) -> RustClosure

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RustClosure

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

Formats the value using the given formatter.

impl From<RustClosure> for Closure

fn from(c: RustClosure) -> Self

Converts to this type from the input type.

impl Hash for RustClosure

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 RustClosure

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

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

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

impl StructuralPartialEq for RustClosure