Struct godot::obj::NotUniqueError

pub struct NotUniqueError { /* private fields */ }

Error stemming from the non-uniqueness of the Gd instance.

Keeping track of the uniqueness of references can be crucial in many applications, especially if we want to ensure that the passed Gd reference will be possessed by only one different object instance or function in its lifetime.

Only applicable to GodotClass objects that inherit from RefCounted. To check the uniqueness, call the check() associated method.

Example

use godot::prelude::*;
use godot::obj::NotUniqueError;

let shared = RefCounted::new_gd();
let cloned = shared.clone();
let result = NotUniqueError::check(shared);

assert!(result.is_err());

if let Err(error) = result {
    assert_eq!(error.get_reference_count(), 2)
}

Implementations

impl NotUniqueError

pub fn check<T>(rc: Gd<T>) -> Result<Gd<T>, NotUniqueError>

where T: Inherits<RefCounted>,

check Gd reference uniqueness.

Checks the Gd of the GodotClass that inherits from RefCounted if it is an unique reference to the object.

Example

use godot::prelude::*;
use godot::obj::NotUniqueError;

let unique = RefCounted::new_gd();
assert!(NotUniqueError::check(unique).is_ok());

let shared = RefCounted::new_gd();
let cloned = shared.clone();
assert!(NotUniqueError::check(shared).is_err());
assert!(NotUniqueError::check(cloned).is_err());

pub fn get_reference_count(&self) -> i32

Get the detected reference count

Trait Implementations

impl Debug for NotUniqueError

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

Formats the value using the given formatter.

impl Display for NotUniqueError

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

Formats the value using the given formatter.

impl Error for NotUniqueError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.