Struct ClassId 

pub struct ClassId { /* private fields */ }

Globally unique ID of a class registered with Godot.

This struct implements Copy and is very cheap to copy and compare with other ClassIds.

ClassId can also be used to obtain the class name, which is cached globally, not per-instance. Note that it holds the Godot name, not the Rust name – they sometimes differ, e.g. Godot CSGMesh3D vs Rust CsgMesh3D.

You can access existing classes’ ID using GodotClass::class_id(). If you need to create your own class ID, use new_cached().

Ordering

ClassIds are not ordered lexicographically, and the ordering relation is not stable across multiple runs of your application. When lexicographical order is needed, it’s possible to convert this type to GString or String. Note that StringName does not implement Ord, and its Godot comparison operators are not lexicographical either.

Implementations

impl ClassId

pub fn new_cached<T>(init_fn: impl FnOnce() -> String) -> ClassId

where T: GodotClass,

Construct a new class name.

You should typically only need this when implementing GodotClass manually, without #[derive(GodotClass)], and overriding class_id(). To access an existing type’s class name, use <T as GodotClass>::class_id().

This function is expensive the first time it called for a given T, but will be cached for subsequent calls. It can make sense to store the result in a static, to further reduce lookup times, but it’s not required.

We discourage calling this function from different places for the same T. But if you do so, init_fn must return the same string.

Panics

If the string is not ASCII and the Godot version is older than 4.4. From Godot 4.4 onwards, class names can be Unicode.

pub fn to_gstring(&self) -> GString

Returns the class name as a GString.

pub fn to_string_name(&self) -> StringName

Returns the class name as a StringName.

pub fn to_cow_str(&self) -> Cow<'static, str>

Returns an owned or borrowed str representing the class name.

Trait Implementations

impl Clone for ClassId

fn clone(&self) -> ClassId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClassId

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

Formats the value using the given formatter.

impl Display for ClassId

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

Formats the value using the given formatter.

impl Hash for ClassId

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 ClassId

fn cmp(&self, other: &ClassId) -> 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 ClassId

fn eq(&self, other: &ClassId) -> 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 ClassId

fn partial_cmp(&self, other: &ClassId) -> 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 Copy for ClassId

impl Eq for ClassId

impl StructuralPartialEq for ClassId