Struct Resource

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

Expand description

Represents the base class for all resources. This base class contains information related to the type of the resource and the loading status of the resource data. The actual resource data is specific to the sub-classes.

Implementations§

impl Resource

pub fn get_name(&self) -> Result<KanziString, Error>

Gets the resource name.

pub fn get_url(&self) -> Result<KanziString, Error>

Gets the resource URL. Note that the URL is not necessarily in URL form if resource has been just created.

§Returns

URL string.

pub fn set_keep_alive(&self, keep_alive: bool) -> Result<(), Error>

Sets the keep alive flag. Can be set only before the resource is registered to the resource manager. Normally set by loadFromKZB.

§Arguments

keep_alive - Value for the keep alive flag.

Methods from Deref<Target = Object>§

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

pub fn as_wrapper(&self) -> &ObjectWrapper

pub fn as_object(&self) -> &Object

Represents any type inheriting from Object as &Object. This is useful for comparisions when PartialEq traits failed to compare objects of different types.

let child = screen.get_child(0)?;
let parent = child.get_parent()?.into_error(ErrorKind::ObjectNotFound)?;
// assert_eq!(screen, parent); // <- Fails to compile!
assert_eq!(screen.as_object(), parent.as_object());

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

pub fn is_stale(&self) -> bool

Checks whether the weak reference has expired.

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>
where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers.

Base value is affected by the following inputs where the highest entry in the list determines the base value:

Local value set with setProperty or loaded from kzb
Value set by a style affecting the property.
Value defined by class metadata.

Modifiers are not applied, the highest-priority base value is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

§Arguments

property_type - The property type identifying the property to retrieve.

§Returns

The evaluated property value.

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>
where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

If there is no value sources, None is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

§Arguments

property_type - The property type identifying the property to retrieve.

§Returns

The evaluated property value.

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

Sets the local value of a property type.

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>
where T: PropertyTypeConstraint,

Evaluates whether there are any inputs into the property value. Both value sources and modifiers are taken into account.

§Returns

Returns true if there are inputs into the property value, false otherwise.

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

Removes the local value associated with the property.

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

Returns the metaclass of the dynamic type of the object.

pub fn get_domain(&self) -> Result<Domain, Error>

Returns the domain the object belongs to.

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

Sets the flag to indicate that the property was loaded from KZB.

pub fn debug_string(&self) -> Result<String, Error>

Builds a string representation of the object intended for debugging purposes.

Trait Implementations§

impl Clone for Resource

fn clone(&self) -> Resource

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Resource

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

Formats the value using the given formatter. Read more

impl Deref for Resource

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &<Resource as Deref>::Target

Dereferences the value.

impl Inheritable for Resource

unsafe fn downcast_unchecked<T>(self) -> T
where T: Inherits<Self>,

Downcast the object to a more specific type. Read more

unsafe fn downcast_unchecked_ref<T>(&self) -> &T
where T: Inherits<Self>,

Downcast the object reference to a more specific type. Read more

impl Inherits<Object> for Resource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for AnimationResource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for BinaryResource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for BitmapFontFile

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for BlitRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for BlurEffect2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Brush

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for ClearRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for ColorBrush

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for CompositionBrush

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for CompositionTargetRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for ContentBrush

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for CubeMapRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for DataContext

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for DataObject<()>

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl<T> Inherits<Resource> for DataObject<T>
where T: DataObjectConstraint,

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for DataObjectList

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for DataSource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for DrawObjectsRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for DrawObjectsWithMaterialRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for EffectStack2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for FontFamily

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for FontFile

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Framebuffer

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for GPUResource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for GatherLightsRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for GatherNearestLightsRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for LegacyRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for MaskEffect2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Material

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for MaterialBrush

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for MaterialSetupRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Mesh

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Morph

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for NodeEffect2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for NodeEffectPrefab2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for NodeListRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for NullBrush

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for ObjectSource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for OutlineEffect2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for PageTransitionCollection

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for PipelineStateRenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for PrefabTemplate

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for PrefabTemplateNode

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for RenderPass

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for RenderPassPrefab

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for RenderPassView

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Renderbuffer

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for ResourceDictionary

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for ResourceDictionarySelector

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for ShaderProgram

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for ShadowEffect2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for StateManager

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Style

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Surface

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for TextResource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Texture

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for TextureBrush

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for TimelineResource

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for Trajectory

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for Resource

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for Resource

fn downcast<T>(self) -> Result<Option<T>, Error>
where T: MetaInherits<Self>,

Casts metaclass to a more specific type by value.

fn downcast_ref<T>(&self) -> Result<Option<&T>, Error>
where T: MetaInherits<Self>,

Casts metaclass to a more specific type by reference.

fn is_a<T>(&self) -> Result<bool, Error>
where T: MetaInherits<Self>,

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

fn downgrade(self) -> Weak<Self>

fn downgrade_ref(&self) -> Weak<Self>

fn lock(self) -> ThreadObject<Self>

fn lock_ref(&self) -> ThreadObject<Self>

impl<T> PartialEq<T> for Resource
where T: ObjectConstraint,

fn eq(&self, rhs: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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<T> PartialEq<Weak<T>> for Resource
where T: ObjectConstraint,

fn eq(&self, rhs: &Weak<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 VariantConstraint for Resource

type DataArg<'a> = Option<&'a Resource>

Specifies the type of an argument that provides a value to Variant. Generally, this type matches Self, except for KanziString, Resource, and ResourceId. Read more

type RetArg = Option<Weak<Resource>>

Specifies the type of the return value received from Variant. Generally, this type matches Self, except for Resource. Read more

fn as_arg(&self) -> <Resource as VariantConstraint>::DataArg<'_>

Converts Self to a type accepted by Variant::create or Object::set_property.

impl Eq for Resource

impl PropertyTypeConstraint for Resource

Auto Trait Implementations§

impl Freeze for Resource

impl RefUnwindSafe for Resource

impl !Send for Resource

impl !Sync for Resource

impl Unpin for Resource

impl UnwindSafe for Resource

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> AsAny for T
where T: 'static,

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

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

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> 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> Inherits<T> for T

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

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<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> 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 = Infallible

The type returned in the event of a conversion error.

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

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.

impl<Base, T> MetaInherits<Base> for T
where Base: ObjectConstraint, T: Inherits<Base> + ObjectConstraint,