Skip to main content

Ref

Struct Ref

pub struct Ref<T: ObjectType> { /* private fields */ }

Expand description

A strong reference to an object of class T or a class derived from it.

Cloning the handle shares the object. Equality and hashing are by object identity.

Implementations§

impl<T: ObjectType> Ref<T>

pub fn upcast<U: ObjectType>(self) -> Ref<U>
where T: Upcast<U>,

Converts the handle to a handle of a base class.

pub fn upcast_ref<U: ObjectType>(&self) -> &Ref<U>
where T: Upcast<U>,

Borrows the handle as a handle of a base class, without a copy of the handle (the borrowing form of upcast).

pub fn cast<U: ObjectType>(&self) -> Option<Ref<U>>

Returns a handle of class U if the object is a U.

pub fn downcast<U: ObjectType>(self) -> Result<Ref<U>, Self>

Converts the handle to class U if the object is a U, otherwise returns the handle unchanged.

pub fn is<U: ObjectType>(&self) -> bool

Whether the object is of class U or a class derived from it.

pub fn downgrade(&self) -> WeakRef<T>

Creates a weak reference to the object.

pub fn ptr_eq<U: ObjectType>(&self, other: &Ref<U>) -> bool

Whether two handles refer to the same object.

Trait Implementations§

impl<T: ObjectType> Clone for Ref<T>

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<T: ObjectType> Debug for Ref<T>

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

Formats the value using the given formatter. Read more

impl<T: ObjectType> Deref for Ref<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ObjectType> Eq for Ref<T>

impl From<&Ref<Animation>> for Rc<dyn IAnimation>

fn from(value: &Ref<Animation>) -> Self

Converts to this type from the input type.

impl From<&Ref<CroppedBitmap>> for Rc<dyn IImage>

fn from(value: &Ref<CroppedBitmap>) -> Self

Converts to this type from the input type.

impl From<&Ref<DrawingImage>> for Rc<dyn IImage>

fn from(value: &Ref<DrawingImage>) -> Self

Converts to this type from the input type.

impl From<&Ref<StyleBase>> for Rc<dyn IResourceProvider>

fn from(value: &Ref<StyleBase>) -> Self

Converts to this type from the input type.

impl From<&Ref<Styles>> for Rc<dyn IResourceProvider>

fn from(value: &Ref<Styles>) -> Self

Converts to this type from the input type.

impl From<&Ref<Styles>> for Rc<dyn IStyle>

fn from(value: &Ref<Styles>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<TransitionBase>> From<&Ref<T>> for Rc<dyn ITransition>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyledElement>> From<&Ref<T>> for ResourceHostRef

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<ResourceDictionary>> From<&Ref<T>> for Rc<dyn IThemeVariantProvider>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<ResourceProvider>> From<&Ref<T>> for Rc<dyn IResourceProvider>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<Effect>> From<&Ref<T>> for Rc<dyn IEffect>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<Brush>> From<&Ref<T>> for Rc<dyn IBrush>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<DashStyle>> From<&Ref<T>> for Rc<dyn IDashStyle>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<Pen>> From<&Ref<T>> for Rc<dyn IPen>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<Transform>> From<&Ref<T>> for Rc<dyn ITransform>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<ExperimentalAcrylicMaterial>> From<&Ref<T>> for Rc<dyn IExperimentalAcrylicMaterial>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyledElement>> From<&Ref<T>> for StyleHostRef

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyleBase>> From<&Ref<T>> for Rc<dyn IStyle>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyledElement>> From<&Ref<T>> for Rc<dyn INamed>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyledElement>> From<&Ref<T>> for Rc<dyn ISupportInitialize>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<U>, U: ObjectType> From<&Ref<T>> for Nullable<U>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<U>, U: ObjectType> From<&Ref<T>> for ElementRef<U>

fn from(value: &Ref<T>) -> Self

Converts to this type from the input type.

impl From<Ref<Animation>> for Rc<dyn IAnimation>

fn from(value: Ref<Animation>) -> Self

Converts to this type from the input type.

impl From<Ref<CroppedBitmap>> for Rc<dyn IImage>

fn from(value: Ref<CroppedBitmap>) -> Self

Converts to this type from the input type.

impl From<Ref<DrawingImage>> for Rc<dyn IImage>

fn from(value: Ref<DrawingImage>) -> Self

Converts to this type from the input type.

impl From<Ref<StyleBase>> for Rc<dyn IAddChild<BoxedValue>>

fn from(value: Ref<StyleBase>) -> Self

Converts to this type from the input type.

impl From<Ref<StyleBase>> for Rc<dyn IResourceProvider>

fn from(value: Ref<StyleBase>) -> Self

Converts to this type from the input type.

impl From<Ref<Styles>> for Rc<dyn IStyle>

fn from(value: Ref<Styles>) -> Self

Converts to this type from the input type.

impl From<Ref<Styles>> for Rc<dyn IResourceProvider>

fn from(value: Ref<Styles>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<TransitionBase>> From<Ref<T>> for Rc<dyn ITransition>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyledElement>> From<Ref<T>> for ResourceHostRef

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<ResourceDictionary>> From<Ref<T>> for Rc<dyn IThemeVariantProvider>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<ResourceDictionary>> From<Ref<T>> for Rc<dyn IResourceDictionary>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<ResourceProvider>> From<Ref<T>> for Rc<dyn IResourceProvider>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<Effect>> From<Ref<T>> for Rc<dyn IEffect>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<Brush>> From<Ref<T>> for Rc<dyn IBrush>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<DashStyle>> From<Ref<T>> for Rc<dyn IDashStyle>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<GradientStop>> From<Ref<T>> for Rc<dyn IGradientStop>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<Pen>> From<Ref<T>> for Rc<dyn IPen>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<Transform>> From<Ref<T>> for Rc<dyn ITransform>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<ExperimentalAcrylicMaterial>> From<Ref<T>> for Rc<dyn IExperimentalAcrylicMaterial>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyledElement>> From<Ref<T>> for StyleHostRef

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyleBase>> From<Ref<T>> for Rc<dyn IStyle>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyledElement>> From<Ref<T>> for Rc<dyn INamed>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<StyledElement>> From<Ref<T>> for Rc<dyn ISupportInitialize>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl<T: ObjectType + Upcast<U>, U: ObjectType> From<Ref<T>> for Nullable<U>

fn from(value: Ref<T>) -> Self

Converts to this type from the input type.

impl FromIterator<Ref<Drawing>> for DrawingCollection

fn from_iter<I: IntoIterator<Item = Ref<Drawing>>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl FromIterator<Ref<Geometry>> for GeometryCollection

fn from_iter<I: IntoIterator<Item = Ref<Geometry>>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl FromIterator<Ref<GradientStop>> for GradientStops

fn from_iter<I: IntoIterator<Item = Ref<GradientStop>>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl FromIterator<Ref<PathFigure>> for PathFigures

fn from_iter<I: IntoIterator<Item = Ref<PathFigure>>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl FromIterator<Ref<PathSegment>> for PathSegments

fn from_iter<I: IntoIterator<Item = Ref<PathSegment>>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl FromIterator<Ref<TextDecoration>> for TextDecorationCollection

fn from_iter<I: IntoIterator<Item = Ref<TextDecoration>>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl FromIterator<Ref<Transform>> for Transforms

fn from_iter<I: IntoIterator<Item = Ref<Transform>>>(iter: I) -> Self

Creates a value from an iterator. Read more

impl<T: ObjectType> Hash for Ref<T>

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

impl<T: ObjectType + Upcast<U>, U: ObjectType> IntoRef<U> for Ref<T>

fn into_ref(self) -> Ref<U>

impl<T: ObjectType + Upcast<U>, U: ObjectType> IntoRef<U> for &Ref<T>

fn into_ref(self) -> Ref<U>

impl<T: ObjectType, U: ObjectType> PartialEq<Ref<U>> for Ref<T>

fn eq(&self, other: &Ref<U>) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl<T: ObjectType> WeakEventSender for Ref<T>

type Weak = WeakRef<T>

The weak form of the handle.

fn downgrade_sender(&self) -> WeakRef<T>

fn upgrade_sender(weak: &WeakRef<T>) -> Option<Self>

fn sender_address(&self) -> usize

The address of the object the handle refers to.

Auto Trait Implementations§

impl<T> !RefUnwindSafe for Ref<T>

impl<T> !Send for Ref<T>

impl<T> !Sync for Ref<T>

impl<T> !UnwindSafe for Ref<T>

impl<T> Freeze for Ref<T>
where PhantomData<T>: Freeze,

impl<T> Unpin for Ref<T>
where PhantomData<T>: Unpin,

impl<T> UnsafeUnpin for Ref<T>
where PhantomData<T>: UnsafeUnpin,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AnyValue for T
where T: PartialEq + 'static,

fn any_value_as_any(&self) -> &(dyn Any + 'static)

fn any_value_eq(&self, other: &(dyn AnyValue + 'static)) -> bool

fn any_value_type_name(&self) -> &'static str

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> ClassDefaults for T
where T: ?Sized,

fn static_constructor()

The static constructor of a type: work done once per thread, after the properties of the type are registered and before its first instance exists (class handlers, affects_render, metadata overrides). Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> PropertyValue for T
where T: Clone + PartialEq + 'static,

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> ResourceKeyObject for T
where T: Eq + Hash + 'static,

fn as_any(&self) -> &(dyn Any + 'static)

fn dyn_eq(&self, other: &(dyn ResourceKeyObject + 'static)) -> bool

fn dyn_hash(&self, state: &mut dyn Hasher)

fn key_type_name(&self) -> &'static str

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.