Struct glib::BoxedAnyObject

#[repr(transparent)]
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::static_type());
list.append(&boxed);

Implementations

impl BoxedAnyObject

pub fn new<T: 'static>(value: T) -> Self

Creates a new BoxedAnyObject containing value

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

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: 'static>(&self) -> Result<Ref<'_, T>, BorrowError>

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: 'static>( &mut self ) -> Result<RefMut<'_, T>, BorrowMutError>

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: 'static>(&self) -> Ref<'_, T>

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: 'static>(&self) -> RefMut<'_, T>

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) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoxedAnyObject

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

Formats the value using the given formatter.

impl Hash for BoxedAnyObject

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

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

type Subclass = BoxedAnyObject

impl Ord for BoxedAnyObject

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for BoxedAnyObject

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for BoxedAnyObject

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

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

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.

impl<OT: ObjectType> PartialOrd<OT> for BoxedAnyObject

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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