Struct gdnative_core::core_types::Rid

pub struct Rid(_);

A RID (“resource ID”) is an opaque handle that refers to a Godot Resource.

RIDs do not grant access to the resource itself. Instead, they can be used in lower-level resource APIs such as the servers. See also Godot API docs for RID.

Note that RIDs are highly unsafe to work with (especially with a Release build of Godot):

• They are untyped, i.e. Godot does not recognize if they represent the correct resource type.
• The internal handle is interpreted as a raw pointer by Godot, meaning that passing an invalid or wrongly typed RID is instant undefined behavior.

For this reason, GDNative methods accepting Rid parameters are marked unsafe.

Implementations

impl Rid

pub fn new() -> Self

Creates an empty, invalid RID.

pub unsafe fn get_id(self) -> i32

Returns the ID of the referenced resource.

Panics

When this instance is empty, i.e. self.is_occupied() is false.

Safety

RIDs are untyped and interpreted as raw pointers by the engine. If this method is called on an invalid resource ID, the behavior is undefined. This can happen when the resource behind the RID is no longer alive.

pub fn is_occupied(self) -> bool

Check if this RID is non-empty. This does not mean it’s valid or safe to use!

This simply checks if the handle has not been initialized with the empty default. It does not give any indication about whether it points to a valid resource.

Trait Implementations

impl Clone for Rid

fn clone(&self) -> Rid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CoerceFromVariant for Rid

fn coerce_from_variant(v: &Variant) -> Self

impl Debug for Rid

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

Formats the value using the given formatter.

impl Default for Rid

fn default() -> Self

Returns the “default value” for a type.

impl Export for Rid

type Hint = NoHint

A type-specific hint type that is valid for the type being exported.

fn export_info(_hint: Option<Self::Hint>) -> ExportInfo

Returns ExportInfo given an optional typed hint.

impl FromVariant for Rid

fn from_variant(variant: &Variant) -> Result<Self, FromVariantError>

impl Ord for Rid

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 PartialEq<Rid> for Rid

fn eq(&self, other: &Self) -> 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 PartialOrd<Rid> for Rid

fn partial_cmp(&self, other: &Self) -> 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 ToVariant for Rid

fn to_variant(&self) -> Variant

impl Copy for Rid

impl Eq for Rid

impl ToVariantEq for Rid