Struct gdnative::NativeRef
[−]
[src]
pub struct NativeRef<T: NativeClass> { /* fields omitted */ }
A reference to a rust native script.
Methods
impl<T: NativeClass> NativeRef<T>
[src]
pub fn from_native_script(script: &NativeScript) -> Option<Self>
[src]
Try to down-cast from a NativeScript
reference.
pub fn from_object(&self, obj: &Object) -> Option<Self>
[src]
Try to down-cast from an Object
reference.
pub fn to_native_script(&self) -> NativeScript
[src]
Up-cast to a NativeScript
reference.
pub fn cast<O>(&self) -> Option<O> where
O: GodotObject,
[src]
O: GodotObject,
Try to cast into a godot object reference.
pub fn new_ref(&self) -> Self
[src]
Creates a new reference to the same object.
Methods from Deref<Target = RefCell<T>>
pub fn replace(&self, t: T) -> T
1.24.0[src]
Replaces the wrapped value with a new one, returning the old value, without deinitializing either one.
This function corresponds to std::mem::replace
.
Panics
Panics if the value is currently borrowed.
Examples
use std::cell::RefCell; let cell = RefCell::new(5); let old_value = cell.replace(6); assert_eq!(old_value, 5); assert_eq!(cell, RefCell::new(6));
pub fn replace_with<F>(&self, f: F) -> T where
F: FnOnce(&mut T) -> T,
[src]
F: FnOnce(&mut T) -> T,
refcell_replace_swap
)Replaces the wrapped value with a new one computed from f
, returning
the old value, without deinitializing either one.
This function corresponds to std::mem::replace
.
Panics
Panics if the value is currently borrowed.
Examples
#![feature(refcell_replace_swap)] use std::cell::RefCell; let cell = RefCell::new(5); let old_value = cell.replace_with(|&mut old| old + 1); assert_eq!(old_value, 5); assert_eq!(cell, RefCell::new(6));
pub fn swap(&self, other: &RefCell<T>)
1.24.0[src]
Swaps the wrapped value of self
with the wrapped value of other
,
without deinitializing either one.
This function corresponds to std::mem::swap
.
Panics
Panics if the value in either RefCell
is currently borrowed.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let d = RefCell::new(6); c.swap(&d); assert_eq!(c, RefCell::new(6)); assert_eq!(d, RefCell::new(5));
pub fn borrow(&self) -> Ref<T>
1.0.0[src]
Immutably borrows the wrapped value.
The borrow lasts until the returned Ref
exits scope. Multiple
immutable borrows can be taken out at the same time.
Panics
Panics if the value is currently mutably borrowed. For a non-panicking variant, use
try_borrow
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let borrowed_five = c.borrow(); let borrowed_five2 = c.borrow();
An example of panic:
use std::cell::RefCell; use std::thread; let result = thread::spawn(move || { let c = RefCell::new(5); let m = c.borrow_mut(); let b = c.borrow(); // this causes a panic }).join(); assert!(result.is_err());
pub fn try_borrow(&self) -> Result<Ref<T>, BorrowError>
1.13.0[src]
Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.
The borrow lasts until the returned Ref
exits scope. Multiple immutable borrows can be
taken out at the same time.
This is the non-panicking variant of borrow
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); { let m = c.borrow_mut(); assert!(c.try_borrow().is_err()); } { let m = c.borrow(); assert!(c.try_borrow().is_ok()); }
pub fn borrow_mut(&self) -> RefMut<T>
1.0.0[src]
Mutably borrows the wrapped value.
The borrow lasts until the returned RefMut
exits scope. The value
cannot be borrowed while this borrow is active.
Panics
Panics if the value is currently borrowed. For a non-panicking variant, use
try_borrow_mut
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); *c.borrow_mut() = 7; assert_eq!(*c.borrow(), 7);
An example of panic:
use std::cell::RefCell; use std::thread; let result = thread::spawn(move || { let c = RefCell::new(5); let m = c.borrow(); let b = c.borrow_mut(); // this causes a panic }).join(); assert!(result.is_err());
pub fn try_borrow_mut(&self) -> Result<RefMut<T>, BorrowMutError>
1.13.0[src]
Mutably borrows the wrapped value, returning an error if the value is currently borrowed.
The borrow lasts until the returned RefMut
exits scope. The value cannot be borrowed
while this borrow is active.
This is the non-panicking variant of borrow_mut
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); { let m = c.borrow(); assert!(c.try_borrow_mut().is_err()); } assert!(c.try_borrow_mut().is_ok());
pub fn as_ptr(&self) -> *mut T
1.12.0[src]
Returns a raw pointer to the underlying data in this cell.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let ptr = c.as_ptr();
Trait Implementations
impl<T: NativeClass> Deref for NativeRef<T>
[src]
type Target = RefCell<T>
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.