Struct InstanceId

pub struct InstanceId { /* private fields */ }

Represents a non-zero instance ID.

This is its own type for type safety and to deal with the inconsistent representation in Godot as both u64 (C++) and i64 (GDScript). You can usually treat this as an opaque value and pass it to and from GDScript; there are conversion methods however.

Implementations

impl InstanceId

pub fn try_from_i64(id: i64) -> Option<InstanceId>

Constructs an instance ID from an integer, or None if the integer is zero.

This does not check if the instance is valid.

pub fn from_i64(id: i64) -> InstanceId

⚠️ Constructs an instance ID from a non-zero integer, or panics.

This does not check if the instance is valid.

Panics

If id is zero. Use try_from_i64 if you are unsure.

pub fn to_i64(self) -> i64

pub fn is_ref_counted(self) -> bool

Returns if the obj being referred-to is inheriting RefCounted.

This is a very fast operation and involves no engine round-trip, as the information is encoded in the ID itself.

pub fn lookup_validity(self) -> bool

Dynamically checks if the instance behind the ID exists.

Rather slow, involves engine round-trip plus object DB lookup. If you need the object, use Gd::from_instance_id() instead.

This corresponds to Godot’s global function is_instance_id_valid().

Trait Implementations

impl Clone for InstanceId

fn clone(&self) -> InstanceId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceId

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

Formats the value using the given formatter.

impl Display for InstanceId

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

Formats the value using the given formatter.

impl FromGodot for InstanceId

fn try_from_godot( via: <InstanceId as GodotConvert>::Via, ) -> Result<InstanceId, ConvertError>

Converts the Godot representation to this type, returning Err on failure.

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type.

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a Variant, returning Err on failure.

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a Variant.

impl GodotConvert for InstanceId

type Via = i64

The type through which Self is represented in Godot.

impl Hash for InstanceId

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 Ord for InstanceId

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

This method returns an Ordering between self and other.

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

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

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

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 PartialOrd for InstanceId

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

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

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 ToGodot for InstanceId

type ToVia<'v> = i64

Target type of to_godot(), which differs from Via for pass-by-reference types.

fn to_godot(&self) -> <InstanceId as ToGodot>::ToVia<'_>

Converts this type to the Godot type by reference, usually by cloning.

fn to_variant(&self) -> Variant

Converts this type to a Variant.

impl Copy for InstanceId

impl Eq for InstanceId

impl StructuralPartialEq for InstanceId