Struct ClassName

pub struct ClassName { /* private fields */ }

Name of a class registered with Godot.

Holds the Godot name, not the Rust name (they sometimes differ, e.g. Godot CSGMesh3D vs Rust CsgMesh3D).

This struct is very cheap to copy. The actual names are cached globally.

If you need to create your own class name, use new_cached().

Ordering

ClassNames 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.

Implementations

impl ClassName

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

Construct a new class name.

This is expensive the first time it called for a given T, but will be cached for subsequent calls.

It is not specified when exactly init_fn is invoked. However, it must return the same value for the same T. Generally, we expect to keep the invocations limited, so you can use more expensive construction in the closure.

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

Converts the class name to a GString.

pub fn to_string_name(&self) -> StringName

Converts the class name to a StringName.

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

Returns an owned or borrowed str.

Trait Implementations

impl Clone for ClassName

fn clone(&self) -> ClassName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClassName

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

Formats the value using the given formatter.

impl Display for ClassName

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

Formats the value using the given formatter.

impl Hash for ClassName

fn hash<__H: Hasher>(&self, state: &mut __H)

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 ClassName

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

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

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

impl Eq for ClassName

impl StructuralPartialEq for ClassName