Struct glib::closure::Closure

source ·
#[repr(transparent)]
pub struct Closure { /* private fields */ }

Implementations§

source§

impl Closure

source

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

Return the inner pointer to the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow<'a>(ptr: *const *const GClosure) -> &'a Self

Borrows the underlying C value.

source§

impl Closure

source

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);
source

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.

source

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.

source

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.

source

pub fn invalidate(&self)

Invalidates the closure.

Invoking an invalidated closure has no effect.

Trait Implementations§

source§

impl AsRef<Closure> for Closure

source§

fn as_ref(&self) -> &Closure

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

impl AsRef<Closure> for RustClosure

source§

fn as_ref(&self) -> &Closure

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

impl Clone for Closure

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Closure

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Closure> for Value

source§

fn from(s: Closure) -> Self

Converts to this type from the input type.
source§

impl From<RustClosure> for Closure

source§

fn from(c: RustClosure) -> Self

Converts to this type from the input type.
source§

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>

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for Closure

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Closure

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq<Closure> for Closure

source§

fn eq(&self, other: &Closure) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialOrd<Closure> for Closure

source§

fn partial_cmp(&self, other: &Closure) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl StaticType for Closure

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for Closure

source§

impl Send for Closure

source§

impl StructuralEq for Closure

source§

impl StructuralPartialEq for Closure

source§

impl Sync for Closure

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for Twhere
    T: Into<Value>,

source§

impl<T> StaticTypeExt for Twhere
    T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToSendValue for Twhere
    T: Send + ToValue + ?Sized,

source§

fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.
source§

impl<T> TransparentType for Twhere
    T: TransparentPtrType,

source§

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for Twhere
    T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T, C, E> FromValueOptional<'a> for Twhere
    T: FromValue<'a, Checker = C>,
    C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>,
    E: Error + Send + 'static,