Struct godot::builtin::NodePath

pub struct NodePath { /* private fields */ }
Expand description

A pre-parsed scene tree path.

§Null bytes

Note that Godot ignores any bytes after a null-byte. This means that for instance "hello, world!" and "hello, world!\0 ignored by Godot" will be treated as the same string if converted to a NodePath.

Implementations§

§

impl NodePath

pub fn is_empty(&self) -> bool

pub fn hash(&self) -> u32

Returns a 32-bit integer hash value representing the string.

Trait Implementations§

§

impl Clone for NodePath

§

fn clone(&self) -> NodePath

Returns a copy 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 NodePath

Uses literal syntax from GDScript: ^"node_path"

§

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

Formats the value using the given formatter. Read more
§

impl Default for NodePath

§

fn default() -> NodePath

Returns the “default value” for a type. Read more
§

impl Display for NodePath

§

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

Formats the value using the given formatter. Read more
§

impl Drop for NodePath

§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

impl Export for NodePath

§

fn default_export_info() -> PropertyHintInfo

The export info to use for an exported field of this type, if no other export info is specified.
§

impl From<&GString> for NodePath

§

fn from(string: &GString) -> NodePath

Converts to this type from the input type.
§

impl From<&NodePath> for GString

§

fn from(path: &NodePath) -> GString

Converts to this type from the input type.
§

impl From<&NodePath> for StringName

§

fn from(path: &NodePath) -> StringName

Converts to this type from the input type.
§

impl From<&String> for NodePath

§

fn from(s: &String) -> NodePath

Converts to this type from the input type.
§

impl From<&StringName> for NodePath

§

fn from(string_name: &StringName) -> NodePath

Converts to this type from the input type.
§

impl From<&str> for NodePath

§

fn from(s: &str) -> NodePath

Converts to this type from the input type.
§

impl From<GString> for NodePath

§

fn from(string: GString) -> NodePath

Converts this GString to a NodePath.

This is identical to NodePath::from(&string), and as such there is no performance benefit.

§

impl From<NodePath> for GString

§

fn from(path: NodePath) -> GString

Converts this NodePath to a GString.

This is identical to GString::from(&path), and as such there is no performance benefit.

§

impl From<NodePath> for StringName

§

fn from(path: NodePath) -> StringName

Converts this NodePath to a StringName.

This is identical to StringName::from(&path), and as such there is no performance benefit.

§

impl From<String> for NodePath

§

fn from(s: String) -> NodePath

Converts to this type from the input type.
§

impl From<StringName> for NodePath

§

fn from(string_name: StringName) -> NodePath

Converts this StringName to a NodePath.

This is identical to NodePath::from(&string_name), and as such there is no performance benefit.

§

impl FromGodot for NodePath

§

fn try_from_godot( via: <NodePath as GodotConvert>::Via, ) -> Result<NodePath, 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. Read more
§

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. Read more
§

impl FromStr for NodePath

§

type Err = Infallible

The associated error which can be returned from parsing.
§

fn from_str(string: &str) -> Result<NodePath, <NodePath as FromStr>::Err>

Parses a string s to return a value of this type. Read more
§

impl GodotConvert for NodePath

§

type Via = NodePath

The type through which Self is represented in Godot.
§

impl Hash for NodePath

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq for NodePath

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

§

fn to_godot(&self) -> <NodePath as GodotConvert>::Via

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

fn into_godot(self) -> <NodePath as GodotConvert>::Via

Converts this type to the Godot type. Read more
§

fn to_variant(&self) -> Variant

Converts this type to a Variant.
§

impl TypeStringHint for NodePath

§

fn type_string() -> String

Returns the representation of this type as a type string. Read more
§

impl Var for NodePath

§

impl ArrayElement for NodePath

§

impl Eq for NodePath

§

impl GodotType for NodePath

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.