Struct BoxedAnyObject

pub struct BoxedAnyObject { /* private fields */ }

This is a subclass of glib::object::Object capable of storing any Rust type. It let’s you insert a Rust type anywhere a glib::object::Object is needed. The inserted value can then be borrowed as a Rust type, by using the various provided methods.

Examples

use glib::prelude::*;
use glib::BoxedAnyObject;
use std::cell::Ref;

struct Author {
    name: String,
    subscribers: usize
}
// BoxedAnyObject can contain any custom type
let boxed = BoxedAnyObject::new(Author {
    name: String::from("GLibAuthor"),
    subscribers: 1000
});

// The value can be retrieved with `borrow`
let author: Ref<Author> = boxed.borrow();

use gio::ListStore;

// The boxed data can be stored as a `glib::object::Object`
let list = ListStore::new::<BoxedAnyObject>();
list.append(&boxed);

GLib type: GObject with reference counted clone semantics.

Implementations

impl BoxedAnyObject

pub fn new<T>(value: T) -> BoxedAnyObject

where T: 'static,

Creates a new BoxedAnyObject containing value

pub fn replace<T>(&self, t: T) -> Box<dyn Any>

where T: 'static,

Replaces the wrapped value with a new one, returning the old value, without deinitializing either one. The returned value is inside a Box and must be manually downcasted if needed.

pub fn try_borrow<T>(&self) -> Result<Ref<'_, T>, BorrowError>

where T: 'static,

Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed or if it’s not of type T.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time.

This is the non-panicking variant of borrow.

pub fn try_borrow_mut<T>(&mut self) -> Result<RefMut<'_, T>, BorrowMutError>

where T: 'static,

Mutably borrows the wrapped value, returning an error if the value is currently borrowed. or if it’s not of type T.

The borrow lasts until the returned RefMut or all RefMuts derived from it exit scope. The value cannot be borrowed while this borrow is active.

This is the non-panicking variant of borrow_mut.

pub fn borrow<T>(&self) -> Ref<'_, T>

where T: 'static,

Immutably borrows the wrapped value.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time.

Panics

Panics if the value is currently mutably borrowed or if it’s not of type T.

For a non-panicking variant, use try_borrow.

pub fn borrow_mut<T>(&self) -> RefMut<'_, T>

where T: 'static,

Mutably borrows the wrapped value.

The borrow lasts until the returned RefMut or all RefMuts derived from it exit scope. The value cannot be borrowed while this borrow is active.

Panics

Panics if the value is currently borrowed or if it’s not of type T.

For a non-panicking variant, use try_borrow_mut.

Trait Implementations

impl Clone for BoxedAnyObject

fn clone(&self) -> BoxedAnyObject

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for BoxedAnyObject

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

Formats the value using the given formatter.

impl HasParamSpec for BoxedAnyObject

type ParamSpec = ParamSpecObject

type SetValue = BoxedAnyObject

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

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, BoxedAnyObject>

fn param_spec_builder() -> <BoxedAnyObject as HasParamSpec>::BuilderFn

impl Hash for BoxedAnyObject

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

where H: Hasher,

Hashes the memory address of this object.

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 ObjectSubclassIs for BoxedAnyObject

type Subclass = BoxedAnyObject

impl Ord for BoxedAnyObject

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 ParentClassIs for BoxedAnyObject

type Parent = Object

impl<OT> PartialEq<OT> for BoxedAnyObject

where OT: ObjectType,

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT> PartialOrd<OT> for BoxedAnyObject

where OT: ObjectType,

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 BoxedAnyObject

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for BoxedAnyObject